SU2_TYPE Namespace Reference

Namespace for defining the datatype wrapper routines; this class features as a base class for type interfaces for non-primitive dataypes e.g. used by AD, complex etc. More...

Functions
void	SetValue (su2double &data, const double &val)
	Set the (primitive) value of the datatype (needs to be implemented for each new type). More...
void	SetSecondary (su2double &data, const double &val)
	Set the secondary value of the datatype (needs to be implemented for each new type). More...
double	GetValue (const su2double &data)
	Get the (primitive) value of the datatype (needs to be implemented for each new type). More...
double	GetSecondary (const su2double &data)
	Get the secondary value of the datatype (needs to be implemented for each new type). More...
double	GetDerivative (const su2double &data)
	Get the derivative value of the datatype (needs to be implemented for each new type). More...
void	SetDerivative (su2double &data, const double &val)
	Set the derivative value of the datatype (needs to be implemented for each new type). More...
int	Int (const su2double &data)
	Casts the primitive value to int (uses GetValue, already implemented for each type). More...
short	Short (const su2double &data)
	Casts the primitive value to short (uses GetValue, already implemented for each type). More...
void	SetValue (double &data, const double &val)
double	GetValue (const double &data)
void	SetSecondary (double &data, const double &val)
double	GetDerivative (const double &data)
double	GetSecondary (const double &data)
void	SetDerivative (double &data, const double &val)

Detailed Description

Namespace for defining the datatype wrapper routines; this class features as a base class for type interfaces for non-primitive dataypes e.g. used by AD, complex etc.

Author

T. Albring

Version

5.0.0 "Raven"

Function Documentation

GetDerivative()

double SU2_TYPE::GetDerivative ( const su2double &  data )

inline

Get the derivative value of the datatype (needs to be implemented for each new type).

Parameters

[in]

data

- The non-primitive datatype.

Returns

The derivative value.

GetSecondary()

double SU2_TYPE::GetSecondary ( const su2double &  data )

inline

Get the secondary value of the datatype (needs to be implemented for each new type).

Parameters

[in]

data

- The non-primitive datatype.

Returns

The primitive value.

GetValue()

double SU2_TYPE::GetValue ( const su2double &  data )

inline

Get the (primitive) value of the datatype (needs to be implemented for each new type).

Parameters

[in]

data

- The non-primitive datatype.

Returns

The primitive value.

Int()

int SU2_TYPE::Int ( const su2double &  data )

inline

Casts the primitive value to int (uses GetValue, already implemented for each type).

Parameters

[in]

data

- The non-primitive datatype.

Returns

- The primary value casted to int.

SetDerivative()

void SU2_TYPE::SetDerivative ( su2double &  data, const double &  val  )

inline

Set the derivative value of the datatype (needs to be implemented for each new type).

Parameters

[in]	data	- The non-primitive datatype.
[in]	val	- The value of the derivative.

SetSecondary()

void SU2_TYPE::SetSecondary ( su2double &  data, const double &  val  )

inline

Set the secondary value of the datatype (needs to be implemented for each new type).

Parameters

[in]	data	- The non-primitive datatype.
[in]	val	- The primitive value.

SetValue()

void SU2_TYPE::SetValue ( su2double &  data, const double &  val  )

inline

Set the (primitive) value of the datatype (needs to be implemented for each new type).

Parameters

[in]	data	- The non-primitive datatype.
[in]	val	- The primitive value.

Short()

short SU2_TYPE::Short ( const su2double &  data )

inline

Casts the primitive value to short (uses GetValue, already implemented for each type).

Parameters

[in]

data

- The non-primitive datatype.

Returns

- The primary value casted to short.