SU2
Public Member Functions | Protected Attributes | List of all members
CIteration Class Reference

Parent class for defining a single iteration of a physics problem. More...

#include <iteration_structure.hpp>

Inheritance diagram for CIteration:
CAdjMeanFlowIteration CDiscAdjMeanFlowIteration CFEM_StructuralAnalysis CHeatIteration CMeanFlowIteration CPoissonIteration CWaveIteration

Public Member Functions

 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...
 
virtual 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)
 A virtual member. More...
 
virtual 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)
 A virtual member. More...
 
virtual 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)
 A virtual member. More...
 
virtual void Monitor ()
 A virtual member. More...
 
virtual void Output ()
 A virtual member. More...
 
virtual void Postprocess ()
 A virtual member. More...
 

Protected Attributes

unsigned short nZone
 Total number of zones in the problem.
 

Detailed Description

Parent class for defining a single iteration of a physics problem.

Author
T. Economon
Version
5.0.0 "Raven"

Member Function Documentation

§ Iterate()

void CIteration::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

A virtual member.

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 in CDiscAdjMeanFlowIteration, CAdjMeanFlowIteration, CFEM_StructuralAnalysis, CPoissonIteration, CHeatIteration, CWaveIteration, and CMeanFlowIteration.

§ Monitor()

void CIteration::Monitor ( )
virtual

A virtual member.

Parameters
[in]???- Description here.

Reimplemented in CDiscAdjMeanFlowIteration, CAdjMeanFlowIteration, CFEM_StructuralAnalysis, CPoissonIteration, CHeatIteration, CWaveIteration, and CMeanFlowIteration.

§ Output()

void CIteration::Output ( )
virtual

A virtual member.

Parameters
[in]???- Description here.

Reimplemented in CDiscAdjMeanFlowIteration, CAdjMeanFlowIteration, CFEM_StructuralAnalysis, CPoissonIteration, CHeatIteration, CWaveIteration, and CMeanFlowIteration.

§ Postprocess()

void CIteration::Postprocess ( )
virtual

A virtual member.

Parameters
[in]???- Description here.

Reimplemented in CDiscAdjMeanFlowIteration, CAdjMeanFlowIteration, CFEM_StructuralAnalysis, CPoissonIteration, CHeatIteration, CWaveIteration, and CMeanFlowIteration.

§ Preprocess()

void CIteration::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

A virtual member.

Parameters
[in]???- Description here.

Reimplemented in CDiscAdjMeanFlowIteration, CAdjMeanFlowIteration, CPoissonIteration, CHeatIteration, CWaveIteration, and CMeanFlowIteration.

§ SetGrid_Movement()

void CIteration::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 
)
virtual

Updates the positions and grid velocities for dynamic meshes between physical time steps.

Author
T. Economon
Parameters
[in]geometry- Geometrical definition of the 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.
[in]solver_container- Container vector with all the solutions.
[in]config- Definition of the particular problem.
[in]iZone- Index of the zone.
[in]IntIter- Current sudo time iteration number.
[in]ExtIter- Current physical time iteration number.

§ Update()

void CIteration::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

A virtual member.

Parameters
[in]???- Description here.

Reimplemented in CDiscAdjMeanFlowIteration, CAdjMeanFlowIteration, CFEM_StructuralAnalysis, CPoissonIteration, CHeatIteration, CWaveIteration, and CMeanFlowIteration.


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