CUserDefinedSolution Class Reference

Class to define the required data for a user defined solution. More...

#include <CUserDefinedSolution.hpp>

Inheritance diagram for CUserDefinedSolution:

Public Member Functions
	CUserDefinedSolution (void)
	Constructor of the class.
	CUserDefinedSolution (unsigned short val_nDim, unsigned short val_nvar, unsigned short val_iMesh, CConfig *config)
	~CUserDefinedSolution (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.
void	GetBCState (const su2double *val_coords, const su2double val_t, su2double *val_solution) const override
	Get the boundary conditions state for an exact solution.
void	GetMMSSourceTerm (const su2double *val_coords, const su2double val_t, su2double *val_source) const override
	Get the source term for the manufactured solution (MMS).
bool	IsManufacturedSolution (void) const override
	Whether or not this verification solution is a manufactured 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 bool	ExactSolutionKnown (void) const
	Whether or not the exact solution is known for this verification 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.

Additional Inherited Members
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 a user defined solution.

Author

E. van der Weide, T. Economon

Constructor & Destructor Documentation

CUserDefinedSolution() [1/2]

CUserDefinedSolution::CUserDefinedSolution

(

void

)

Constructor of the class.

CUserDefinedSolution() [2/2]

CUserDefinedSolution::CUserDefinedSolution	(	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.

~CUserDefinedSolution()

CUserDefinedSolution::~CUserDefinedSolution ( void  )

overridedefault

Destructor of the class.

Member Function Documentation

GetBCState()

void CUserDefinedSolution::GetBCState ( const su2double *  val_coords, const su2double  val_t, su2double *  val_solution  ) const

overridevirtual

Get the boundary conditions state for an exact solution.

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.

GetMMSSourceTerm()

void CUserDefinedSolution::GetMMSSourceTerm ( const su2double *  val_coords, const su2double  val_t, su2double *  val_source  ) const

overridevirtual

Get the source term for the manufactured solution (MMS).

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.

GetSolution()

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

IsManufacturedSolution()

bool CUserDefinedSolution::IsManufacturedSolution ( void  ) const

overridevirtual

Whether or not this verification solution is a manufactured solution.

Returns

- True if this is a manufactured solution and false otherwise.

Reimplemented from CVerificationSolution.

---

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

• Common/include/toolboxes/MMS/CUserDefinedSolution.hpp
• Common/src/toolboxes/MMS/CUserDefinedSolution.cpp