geos::siloFileUtilities Namespace Reference

Functions
template<typename OUTTYPE >
int	DB_TYPE ()
template<typename TYPE >
int	GetNumberOfVariablesInField ()
template<typename TYPE >
int	GetTensorRank ()
template<typename OUTTYPE , typename TYPE >
OUTTYPE	CastField (const TYPE &field, int const i=0)
template<>
real64	CastField (R1Tensor const &field, int const i)
	Specialization for R1Tensor. More...
template<>
int	CastField< int, int > (const int &field, int const dummy)
template<>
long int	CastField< long int, long int > (const long int &field, int const dummy)
template<>
int	CastField< int, long int > (const long int &field, int const dummy)
template<>
long long int	CastField< long long int, long long int > (const long long int &field, int const dummy)
template<>
int	CastField< int, long long int > (const long long int &field, int const dummy)
template<>
real64	CastField< real64, real64 > (const real64 &field, int const dummy)
template<>
float	CastField< float, real64 > (const real64 &field, int const dummy)
template<typename TYPE >
void	SetVariableNames (string const &fieldName, string_array &varnamestring, char const *varnames[])

Detailed Description

Namespace to hold some utilities needed by the functions in SiloFile.

Function Documentation

CastField() [1/2]

template<typename OUTTYPE , typename TYPE >

OUTTYPE geos::siloFileUtilities::CastField	(	const TYPE &	field,
		int const	i = 0
	)

Template Parameters

OUTTYPE	the type to cast to
TYPE	the type to cast from

Parameters

field	the value to cast
i	the component of the varaible to cast, assuming there is dimensionaliy to the variable

Returns

the casted value

CastField() [2/2]

template<>

real64 geos::siloFileUtilities::CastField ( R1Tensor const &  field, int const  i  )

inline

Specialization for R1Tensor.

Parameters

field	the value to cast
i	the component of the variable to cast

Returns

the casted value

Definition at line 794 of file SiloFile.hpp.

CastField< float, real64 >()

template<>

float geos::siloFileUtilities::CastField< float, real64 > ( const real64 &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 884 of file SiloFile.hpp.

CastField< int, int >()

template<>

int geos::siloFileUtilities::CastField< int, int > ( const int &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 806 of file SiloFile.hpp.

CastField< int, long int >()

template<>

int geos::siloFileUtilities::CastField< int, long int > ( const long int &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 832 of file SiloFile.hpp.

CastField< int, long long int >()

template<>

int geos::siloFileUtilities::CastField< int, long long int > ( const long long int &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 858 of file SiloFile.hpp.

CastField< long int, long int >()

template<>

long int geos::siloFileUtilities::CastField< long int, long int > ( const long int &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 819 of file SiloFile.hpp.

CastField< long long int, long long int >()

template<>

long long int geos::siloFileUtilities::CastField< long long int, long long int > ( const long long int &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 845 of file SiloFile.hpp.

CastField< real64, real64 >()

template<>

real64 geos::siloFileUtilities::CastField< real64, real64 > ( const real64 &  field, int const  dummy  )

inline

Todo:

Verify: the TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

field	the value to cast
dummy	unused parameter

Returns

the casted value

Definition at line 871 of file SiloFile.hpp.

DB_TYPE()

template<typename OUTTYPE >

int geos::siloFileUtilities::DB_TYPE

(

)

Template Parameters

OUTTYPE

the type of data to write out (int,float,real64)

Returns

the integer identifier associated with the enum DBdatatype defined in the silo.h file.

This templated function is a "specialization only" definition. There is no general definition, only specializations for predetermined data types.

GetNumberOfVariablesInField()

template<typename TYPE >

int geos::siloFileUtilities::GetNumberOfVariablesInField

(

)

Template Parameters

TYPE	the data type in question

Returns

the number of "variables" in a data field. For instance, 1 for a int, float or real64. 1 for a scalar 3 for a R1Tensor...etc.

GetTensorRank()

template<typename TYPE >

int geos::siloFileUtilities::GetTensorRank

(

)

Template Parameters

TYPE	the data type in question

Returns

the silo DB_VARTYPE specifier that describes the rank of the variable.

SetVariableNames()

template<typename TYPE >

void geos::siloFileUtilities::SetVariableNames	(	string const &	fieldName,
		string_array &	varnamestring,
		char const *	varnames[]
	)

Template Parameters

the	type of the field

Parameters

fieldName	the name of the field
varnamestring	an array of strings that hold the generated names
varnames	a pointer to each of the strings that hold the generated names

This function sets variable names for a field. In some cases, this will just fill varnamestring with the input variable, and in other cases such as in the case of a tensor, the names will have a suffix with the component of the tensor.