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

Class for driving an iteration of the heat system. More...

#include <iteration_structure.hpp>

Inheritance diagram for CHeatIteration:
CIteration

Public Member Functions

 CHeatIteration (CConfig *config)
 Constructor of the class. More...
 
 ~CHeatIteration (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 heat 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 heat system. More...
 
void Monitor ()
 Monitors the convergence and other metrics for the heat system. More...
 
void Output ()
 Outputs desired files and quantities for the heat system. More...
 
void Postprocess ()
 Postprocesses the heat system before heading to another physics system or the next iteration. 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 heat system.

Author
T. Economon
Version
5.0.0 "Raven"

Constructor & Destructor Documentation

§ CHeatIteration()

CHeatIteration::CHeatIteration ( CConfig config)

Constructor of the class.

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

Member Function Documentation

§ Iterate()

void CHeatIteration::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 heat 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 CHeatIteration::Monitor ( )
virtual

Monitors the convergence and other metrics for the heat system.

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ Output()

void CHeatIteration::Output ( )
virtual

Outputs desired files and quantities for the heat system.

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ Postprocess()

void CHeatIteration::Postprocess ( )
virtual

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

Parameters
[in]???- Description here.

Reimplemented from CIteration.

§ Preprocess()

void CHeatIteration::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.

§ Update()

void CHeatIteration::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 heat system.

Parameters
[in]???- Description here.

Reimplemented from CIteration.


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