SU2
Public Member Functions | List of all members
CMeanFlowIteration Class Reference

Class for driving an iteration of the mean flow system. More...

#include <iteration_structure.hpp>

Inheritance diagram for CMeanFlowIteration:
CIteration

Public Member Functions

 CMeanFlowIteration (CConfig *config)
 Constructor of the class. More...
 
 ~CMeanFlowIteration (void)
 Destructor of the class.
 
void Preprocess (COutput *output, CIntegration ***integration_container, CGeometry ***geometry_container, CSolver ****solver_container, CNumerics *****numerics_container, CConfig **config_container, CSurfaceMovement **surface_movement, CVolumetricMovement **grid_movement, CFreeFormDefBox ***FFDBox, unsigned short val_iZone)
 Preprocessing to prepare for an iteration of the physics. More...
 
void Iterate (COutput *output, CIntegration ***integration_container, CGeometry ***geometry_container, CSolver ****solver_container, CNumerics *****numerics_container, CConfig **config_container, CSurfaceMovement **surface_movement, CVolumetricMovement **grid_movement, CFreeFormDefBox ***FFDBox, unsigned short val_iZone)
 Perform a single iteration of the mean flow system. More...
 
void Update (COutput *output, CIntegration ***integration_container, CGeometry ***geometry_container, CSolver ****solver_container, CNumerics *****numerics_container, CConfig **config_container, CSurfaceMovement **surface_movement, CVolumetricMovement **grid_movement, CFreeFormDefBox ***FFDBox, unsigned short val_iZone)
 Updates the containers for the mean flow system. More...
 
void Monitor ()
 Monitors the convergence and other metrics for the mean flow system. More...
 
void Output ()
 Outputs desired files and quantities for the mean flow system. More...
 
void Postprocess ()
 Postprocesses the mean flow system before heading to another physics system or the next iteration. More...
 
void SetWind_GustField (CConfig *config_container, CGeometry **geometry_container, CSolver ***solver_container)
 Imposes a gust via the grid velocities. More...
 
void InitializeVortexDistribution (unsigned long &nVortex, vector< su2double > &x0, vector< su2double > &y0, vector< su2double > &vort_strength, vector< su2double > &r_core)
 Reads and initializes the vortex positions, strengths and gradient. More...
 
void SetMixingPlane (CGeometry ***geometry_container, CSolver ****solver_container, CConfig **config_container, unsigned short iZone)
 compute and set mixing-plane quantities at the interface between two adjacent zone. More...
 
void SetTurboPerformance (CGeometry ***geometry_container, CSolver ****solver_container, CConfig **config_container, COutput *output, unsigned short iZone)
 compute and set mixing-plane quantities at the interface between two adjacent zone. More...
 
- Public Member Functions inherited from CIteration
 CIteration (CConfig *config)
 Constructor of the class.
 
virtual ~CIteration (void)
 Destructor of the class.
 
virtual void SetGrid_Movement (CGeometry ***geometry_container, CSurfaceMovement **surface_movement, CVolumetricMovement **grid_movement, CFreeFormDefBox ***FFDBox, CSolver ****solver_container, CConfig **config_container, unsigned short val_iZone, unsigned long IntIter, unsigned long ExtIter)
 Updates the positions and grid velocities for dynamic meshes between physical time steps. More...
 

Additional Inherited Members

- Protected Attributes inherited from CIteration
unsigned short nZone
 Total number of zones in the problem.
 

Detailed Description

Class for driving an iteration of the mean flow system.

Author
T. Economon
Version
5.0.0 "Raven"

Constructor & Destructor Documentation

§ CMeanFlowIteration()

CMeanFlowIteration::CMeanFlowIteration ( CConfig config)

Constructor of the class.

Parameters
[in]config- Definition of the particular problem.

Member Function Documentation

§ InitializeVortexDistribution()

void CMeanFlowIteration::InitializeVortexDistribution ( unsigned long &  nVortex,
vector< su2double > &  x0,
vector< su2double > &  y0,
vector< su2double > &  vort_strength,
vector< su2double > &  r_core 
)

Reads and initializes the vortex positions, strengths and gradient.

Author
S. Padron
Parameters
[in]nVortex- number of vortices.
[in]x0- Vector of x-loc of the vortices.
[in]y0- Vector of y-loc of the vortices.
[in]vort_strength- Vector of vortex strengths.
[in]r_core- Vector of vortex core size.

§ Iterate()

void CMeanFlowIteration::Iterate ( COutput output,
CIntegration ***  integration_container,
CGeometry ***  geometry_container,
CSolver ****  solver_container,
CNumerics *****  numerics_container,
CConfig **  config_container,
CSurfaceMovement **  surface_movement,
CVolumetricMovement **  grid_movement,
CFreeFormDefBox ***  FFDBox,
unsigned short  val_iZone 
)
virtual

Perform a single iteration of the mean flow system.

Parameters
[in]output- Pointer to the COutput class.
[in]integration_container- Container vector with all the integration methods.
[in]geometry_container- Geometrical definition of the problem.
[in]solver_container- Container vector with all the solutions.
[in]numerics_container- Description of the numerical method (the way in which the equations are solved).
[in]config_container- Definition of the particular problem.
[in]surface_movement- Surface movement classes of the problem.
[in]grid_movement- Volume grid movement classes of the problem.
[in]FFDBox- FFD FFDBoxes of the problem.

Reimplemented from CIteration.

§ Monitor()

void CMeanFlowIteration::Monitor ( )
virtual

Monitors the convergence and other metrics for the mean flow system.

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ Output()

void CMeanFlowIteration::Output ( )
virtual

Outputs desired files and quantities for the mean flow system.

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ Postprocess()

void CMeanFlowIteration::Postprocess ( )
virtual

Postprocesses the mean flow system before heading to another physics system or the next iteration.

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ Preprocess()

void CMeanFlowIteration::Preprocess ( COutput output,
CIntegration ***  integration_container,
CGeometry ***  geometry_container,
CSolver ****  solver_container,
CNumerics *****  numerics_container,
CConfig **  config_container,
CSurfaceMovement **  surface_movement,
CVolumetricMovement **  grid_movement,
CFreeFormDefBox ***  FFDBox,
unsigned short  val_iZone 
)
virtual

Preprocessing to prepare for an iteration of the physics.

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ SetMixingPlane()

void CMeanFlowIteration::SetMixingPlane ( CGeometry ***  geometry_container,
CSolver ****  solver_container,
CConfig **  config_container,
unsigned short  iZone 
)

compute and set mixing-plane quantities at the interface between two adjacent zone.

Author
S. Vitale
Parameters
[in]geometry_container- Geometrical definition of the problem.
[in]solver_container- Container vector with all the solutions.
[in]config_container- Definition of the particular problem.
[in]iZone- zone of the problem.

§ SetTurboPerformance()

void CMeanFlowIteration::SetTurboPerformance ( CGeometry ***  geometry_container,
CSolver ****  solver_container,
CConfig **  config_container,
COutput output,
unsigned short  iZone 
)

compute and set mixing-plane quantities at the interface between two adjacent zone.

Author
S. Vitale
Parameters
[in]geometry_container- Geometrical definition of the problem.
[in]solver_container- Container vector with all the solutions.
[in]config_container- Definition of the particular problem.
[in]output- Definition of the output for the particular problem.
[in]iZone- zone of the problem.

§ SetWind_GustField()

void CMeanFlowIteration::SetWind_GustField ( CConfig config_container,
CGeometry **  geometry_container,
CSolver ***  solver_container 
)

Imposes a gust via the grid velocities.

Author
S. Padron
Parameters
[in]config_container- Definition of the particular problem.
[in]geometry_container- Geometrical definition of the problem.
[in]solver_container- Container vector with all the solutions.

§ Update()

void CMeanFlowIteration::Update ( COutput output,
CIntegration ***  integration_container,
CGeometry ***  geometry_container,
CSolver ****  solver_container,
CNumerics *****  numerics_container,
CConfig **  config_container,
CSurfaceMovement **  surface_movement,
CVolumetricMovement **  grid_movement,
CFreeFormDefBox ***  FFDBox,
unsigned short  val_iZone 
)
virtual

Updates the containers for the mean flow system.

Parameters
[in]???- Description here.

Reimplemented from CIteration.


The documentation for this class was generated from the following files: