CInviscidVortexSolution Class Reference

Class to define the required data for the Inviscid Vortex. More...

#include <CInviscidVortexSolution.hpp>

Inheritance diagram for CInviscidVortexSolution:

Public Member Functions
	CInviscidVortexSolution (void)
	Constructor of the class.
	CInviscidVortexSolution (unsigned short val_nDim, unsigned short val_nvar, unsigned short val_iMesh, CConfig *config)
	~CInviscidVortexSolution (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.
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	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.
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.

Protected Attributes
su2double	MachVortex
	Mach number of the undisturbed flow.
su2double	x0Vortex
	Initial x-coordinate of the vortex center.
su2double	y0Vortex
	Initial y-coordinate of the vortex center.
su2double	RVortex
	Radius of the vortex.
su2double	epsVortex
	Strength of the vortex.
su2double	thetaVortex
	Advection angle (in degrees) of the vortex.
su2double	Gamma
	Gamma.
su2double	Gm1
	Gamma minus 1.
su2double	ovGm1
	1 over Gamma minus 1
su2double	gamOvGm1
	Gamma 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 Inviscid Vortex.

Author

E. van der Weide, T. Economon

Constructor & Destructor Documentation

CInviscidVortexSolution() [1/2]

CInviscidVortexSolution::CInviscidVortexSolution

(

void

)

Constructor of the class.

CInviscidVortexSolution() [2/2]

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

~CInviscidVortexSolution()

CInviscidVortexSolution::~CInviscidVortexSolution ( void  )

overridedefault

Destructor of the class.

Member Function Documentation

GetBCState()

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

GetSolution()

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

epsVortex

su2double CInviscidVortexSolution::epsVortex

protected

Strength of the vortex.

Gamma

su2double CInviscidVortexSolution::Gamma

protected

Gamma.

gamOvGm1

su2double CInviscidVortexSolution::gamOvGm1

protected

Gamma over Gamma minus 1.

Gm1

su2double CInviscidVortexSolution::Gm1

protected

Gamma minus 1.

MachVortex

su2double CInviscidVortexSolution::MachVortex

protected

Mach number of the undisturbed flow.

ovGm1

su2double CInviscidVortexSolution::ovGm1

protected

1 over Gamma minus 1

RVortex

su2double CInviscidVortexSolution::RVortex

protected

Radius of the vortex.

thetaVortex

su2double CInviscidVortexSolution::thetaVortex

protected

Advection angle (in degrees) of the vortex.

x0Vortex

su2double CInviscidVortexSolution::x0Vortex

protected

Initial x-coordinate of the vortex center.

y0Vortex

su2double CInviscidVortexSolution::y0Vortex

protected

Initial y-coordinate of the vortex center.

---

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

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