CTaskDefinition Class Reference

Class for defining a task to be carried out. More...

#include <task_definition.hpp>

Public Types
enum	SOLVER_TASK {   NO_TASK = 0 , ADER_PREDICTOR_STEP_COMM_ELEMENTS = 1 , ADER_PREDICTOR_STEP_INTERNAL_ELEMENTS = 2 , INITIATE_MPI_COMMUNICATION = 3 ,   COMPLETE_MPI_COMMUNICATION = 4 , INITIATE_REVERSE_MPI_COMMUNICATION = 5 , COMPLETE_REVERSE_MPI_COMMUNICATION = 6 , ADER_TIME_INTERPOLATE_OWNED_ELEMENTS = 7 ,   ADER_TIME_INTERPOLATE_HALO_ELEMENTS = 8 , SHOCK_CAPTURING_VISCOSITY_OWNED_ELEMENTS = 9 , SHOCK_CAPTURING_VISCOSITY_HALO_ELEMENTS = 10 , VOLUME_RESIDUAL = 11 ,   SURFACE_RESIDUAL_OWNED_ELEMENTS = 12 , SURFACE_RESIDUAL_HALO_ELEMENTS = 13 , BOUNDARY_CONDITIONS_DEPEND_ON_OWNED = 14 , BOUNDARY_CONDITIONS_DEPEND_ON_HALO = 15 ,   SUM_UP_RESIDUAL_CONTRIBUTIONS_OWNED_ELEMENTS = 16 , SUM_UP_RESIDUAL_CONTRIBUTIONS_HALO_ELEMENTS = 17 , ADER_ACCUMULATE_SPACETIME_RESIDUAL_OWNED_ELEMENTS = 18 , ADER_ACCUMULATE_SPACETIME_RESIDUAL_HALO_ELEMENTS = 19 ,   MULTIPLY_INVERSE_MASS_MATRIX = 20 , ADER_UPDATE_SOLUTION = 21 }
	Enumerated type, which defines the tasks to be carried out. More...

Public Member Functions
	CTaskDefinition (void)
	Constructor of the class.
	CTaskDefinition (SOLVER_TASK val_task, unsigned short val_timeLevel, int val_ind0MustBeCompleted=-1, int val_ind1MustBeCompleted=-1, int val_ind2MustBeCompleted=-1, int val_ind3MustBeCompleted=-1, int val_ind4MustBeCompleted=-1)
	Alternative constructor of the class, which initializes the member variables to the given arguments.
	~CTaskDefinition (void)
	Destructor of the class.
	CTaskDefinition (const CTaskDefinition &other)
	Copy constructor of the class.
CTaskDefinition &	operator= (const CTaskDefinition &other)
	Assignment operator.

Public Attributes
SOLVER_TASK	task
	Task to be carried out.
unsigned short	timeLevel
	Time level of the task to be carried out.
unsigned short	intPointADER
	Time integration point for ADER, if relevant for the task.
bool	secondPartTimeIntADER
	Whether or not this is the second part of the time interval for elements adjacent to a lower time level.
unsigned short	nIndMustBeCompleted
	Number of relevant indices in indMustBeCompleted.
int	indMustBeCompleted [5]
	Indices in the list of tasks that must be completed before this task can be carried out.

Detailed Description

Class for defining a task to be carried out.

Author

: E. van der Weide, T. Economon

Version

8.5.0 "Harrier"

Member Enumeration Documentation

SOLVER_TASK

enum CTaskDefinition::SOLVER_TASK

Enumerated type, which defines the tasks to be carried out.

Enumerator
NO_TASK	Default value used for checking.
ADER_PREDICTOR_STEP_COMM_ELEMENTS	ADER predictor step for elements whose solution must be communicated.
ADER_PREDICTOR_STEP_INTERNAL_ELEMENTS	ADER predictor step for internal elements.
INITIATE_MPI_COMMUNICATION	Start the communication of the conserved variables.
COMPLETE_MPI_COMMUNICATION	Complete the communication of the conserved variables.
INITIATE_REVERSE_MPI_COMMUNICATION	Start the communication of the residuals.
COMPLETE_REVERSE_MPI_COMMUNICATION	Complete the communication of the residuals.
ADER_TIME_INTERPOLATE_OWNED_ELEMENTS	Carry out a time interpolation to an integration point for the owned elements.
ADER_TIME_INTERPOLATE_HALO_ELEMENTS	Carry out a time interpolation to an integration point for the halo elements.
SHOCK_CAPTURING_VISCOSITY_OWNED_ELEMENTS	Compute the shock capturing artificial viscosity for the owned elements, if needed.
SHOCK_CAPTURING_VISCOSITY_HALO_ELEMENTS	Compute the shock capturing artificial viscosity for the halo elements, if needed.
VOLUME_RESIDUAL	Compute the contribution to the residual from the volume integral.
SURFACE_RESIDUAL_OWNED_ELEMENTS	Compute the contribution to the residual from the interior surface integral between owned elements.
SURFACE_RESIDUAL_HALO_ELEMENTS	Compute the contribution to the residual from the interior surface integral between an owned and halo element.
BOUNDARY_CONDITIONS_DEPEND_ON_OWNED	Compute the contribution to the residual from the boundary conditions that only depend on owned elements.
BOUNDARY_CONDITIONS_DEPEND_ON_HALO	Compute the contribution to the residual from the boundary conditions that depend on halo elements.
SUM_UP_RESIDUAL_CONTRIBUTIONS_OWNED_ELEMENTS	Sum up all contributions to the residual for the owned elements.
SUM_UP_RESIDUAL_CONTRIBUTIONS_HALO_ELEMENTS	Sum up all contributions to the residual for the halo elements.
ADER_ACCUMULATE_SPACETIME_RESIDUAL_OWNED_ELEMENTS	Accumlate the ADER space time residual for the owned elements.
ADER_ACCUMULATE_SPACETIME_RESIDUAL_HALO_ELEMENTS	Accumlate the ADER space time residual for the halo elements.
MULTIPLY_INVERSE_MASS_MATRIX	Multiply the accumulated residual with the inverse of the mass matrix.
ADER_UPDATE_SOLUTION	Update the solution for the ADER scheme.

Constructor & Destructor Documentation

CTaskDefinition() [1/3]

CTaskDefinition::CTaskDefinition ( void  )

inline

Constructor of the class.

CTaskDefinition() [2/3]

CTaskDefinition::CTaskDefinition ( SOLVER_TASK  val_task, unsigned short  val_timeLevel, int  val_ind0MustBeCompleted = -1, int  val_ind1MustBeCompleted = -1, int  val_ind2MustBeCompleted = -1, int  val_ind3MustBeCompleted = -1, int  val_ind4MustBeCompleted = -1  )

inline

Alternative constructor of the class, which initializes the member variables to the given arguments.

Parameters

[in]	val_task	- Task to be set.
[in]	val_timeLevel	- Time level to be set.
[in]	val_ind0MustBeCompleted	- Completed index to be set, defaulted to -1.
[in]	val_ind1MustBeCompleted	- Completed index to be set, defaulted to -1.
[in]	val_ind2MustBeCompleted	- Completed index to be set, defaulted to -1.
[in]	val_ind3MustBeCompleted	- Completed index to be set, defaulted to -1.
[in]	val_ind4MustBeCompleted	- Completed index to be set, defaulted to -1.

~CTaskDefinition()

CTaskDefinition::~CTaskDefinition ( void  )

inline

Destructor of the class.

CTaskDefinition() [3/3]

CTaskDefinition::CTaskDefinition ( const CTaskDefinition &  other )

inline

Copy constructor of the class.

Member Function Documentation

operator=()

CTaskDefinition & CTaskDefinition::operator= ( const CTaskDefinition &  other )

inline

Assignment operator.

Member Data Documentation

indMustBeCompleted

int CTaskDefinition::indMustBeCompleted[5]

Indices in the list of tasks that must be completed before this task can be carried out.

intPointADER

unsigned short CTaskDefinition::intPointADER

Time integration point for ADER, if relevant for the task.

nIndMustBeCompleted

unsigned short CTaskDefinition::nIndMustBeCompleted

Number of relevant indices in indMustBeCompleted.

secondPartTimeIntADER

bool CTaskDefinition::secondPartTimeIntADER

Whether or not this is the second part of the time interval for elements adjacent to a lower time level.

task

SOLVER_TASK CTaskDefinition::task

Task to be carried out.

timeLevel

unsigned short CTaskDefinition::timeLevel

Time level of the task to be carried out.

---

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

• SU2_CFD/include/task_definition.hpp
• SU2_CFD/include/task_definition.inl