Documentation 6b54b78464
Loading...
Searching...
No Matches
CTGVSolution Class Referencefinal

Class to define the required data for the Taylor Green Vortex. More...

#include <CTGVSolution.hpp>

Inheritance diagram for CTGVSolution:
[legend]

Public Member Functions

 CTGVSolution (void)
 Constructor of the class.
 
 CTGVSolution (unsigned short val_nDim, unsigned short val_nvar, unsigned short val_iMesh, CConfig *config)
 
 ~CTGVSolution (void) override
 Destructor of the class.
 
void GetSolution (const su2double *val_coords, const su2double val_t, su2double *val_solution) const override
 Get the exact solution at the current position and time.
 
bool ExactSolutionKnown (void) const override
 Whether or not the exact solution is known for this verification solution.
 
- Public Member Functions inherited from CVerificationSolution
 CVerificationSolution (void)
 Constructor of the class.
 
 CVerificationSolution (unsigned short val_nDim, unsigned short val_nvar, unsigned short val_iMesh, CConfig *config)
 
virtual ~CVerificationSolution (void)
 Destructor of the class.
 
void GetInitialCondition (const su2double *val_coords, su2double *val_solution) const
 Get the exact solution at the current position and t = 0.
 
virtual void GetBCState (const su2double *val_coords, const su2double val_t, su2double *val_solution) const
 Get the boundary conditions state for an exact solution.
 
virtual void GetMMSSourceTerm (const su2double *val_coords, const su2double val_t, su2double *val_source) const
 Get the source term for the manufactured solution (MMS).
 
virtual bool IsManufacturedSolution (void) const
 Whether or not this verification solution is a manufactured solution.
 
void GetLocalError (const su2double *val_coords, const su2double val_t, const su2double *GetLocalErrorval_solution, su2double *val_error) const
 Get the local error defined as the local solution minus the verification solution.
 
void SetError_RMS (unsigned short val_var, su2double val_error)
 Set the global RMS error for verification cases.
 
void AddError_RMS (unsigned short val_var, su2double val_error)
 Increments the global RMS error for verification cases.
 
su2double GetError_RMS (unsigned short val_var) const
 Get the global RMS error for verification cases.
 
void SetError_Max (unsigned short val_var, su2double val_error, unsigned long val_point)
 Set the global maximum error for verification cases.
 
void AddError_Max (unsigned short val_var, su2double val_error, unsigned long val_point, const su2double *val_coord)
 Increment the global maximum error for verification cases.
 
su2double GetError_Max (unsigned short val_var) const
 Get the global maximum error for verification cases.
 
unsigned long GetError_Point_Max (unsigned short val_var) const
 Get the global index of the node with the max error for verification cases.
 
const su2double * GetError_Point_Max_Coord (unsigned short val_var) const
 Get the coordinates of the node with the max error for verification cases.
 
void SetVerificationError (unsigned long nDOFsGlobal, CConfig *config)
 Calculate the global error metrics for verification cases.
 

Protected Attributes

su2double tgvLength
 Taylor-Green length scale.
 
su2double tgvVelocity
 Taylor-Green velocity.
 
su2double tgvDensity
 Taylor-Green density.
 
su2double tgvPressure
 Taylor-Green pressure.
 
su2double ovGm1
 1 over Gamma minus 1
 
- Protected Attributes inherited from CVerificationSolution
int rank
 MPI Rank.
 
int size
 MPI Size.
 
unsigned short nDim
 Number of dimension of the problem.
 
unsigned short nVar
 Number of variables of the problem

 
MAIN_SOLVER Kind_Solver
 The kind of solver we are running.
 

Detailed Description

Class to define the required data for the Taylor Green Vortex.

Author
E. van der Weide, T. Economon

Constructor & Destructor Documentation

◆ CTGVSolution() [1/2]

CTGVSolution::CTGVSolution ( void  )

Constructor of the class.

◆ CTGVSolution() [2/2]

CTGVSolution::CTGVSolution ( unsigned short  val_nDim,
unsigned short  val_nvar,
unsigned short  val_iMesh,
CConfig *  config 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
[in]val_nDim- Number of dimensions of the problem.
[in]val_nvar- Number of variables of the problem.
[in]val_iMesh- Multigrid level of the solver.
[in]config- Configuration of the particular problem.

◆ ~CTGVSolution()

CTGVSolution::~CTGVSolution ( void  )
overridedefault

Destructor of the class.

Member Function Documentation

◆ ExactSolutionKnown()

bool CTGVSolution::ExactSolutionKnown ( void  ) const
overridevirtual

Whether or not the exact solution is known for this verification solution.

Returns
- False, because the exact solution is not known for the TGV case.

Reimplemented from CVerificationSolution.

◆ GetSolution()

void CTGVSolution::GetSolution ( const su2double *  val_coords,
const su2double  val_t,
su2double *  val_solution 
) const
overridevirtual

Get the exact solution at the current position and time.

Parameters
[in]val_coords- Cartesian coordinates of the current position.
[in]val_t- Current physical time.
[in]val_solution- Array where the exact solution is stored.

Reimplemented from CVerificationSolution.

Member Data Documentation

◆ ovGm1

su2double CTGVSolution::ovGm1
protected

1 over Gamma minus 1

◆ tgvDensity

su2double CTGVSolution::tgvDensity
protected

Taylor-Green density.

◆ tgvLength

su2double CTGVSolution::tgvLength
protected

Taylor-Green length scale.

◆ tgvPressure

su2double CTGVSolution::tgvPressure
protected

Taylor-Green pressure.

◆ tgvVelocity

su2double CTGVSolution::tgvVelocity
protected

Taylor-Green velocity.


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