Class to store solver template specifications. More...

#include <solverTemplate.H>

Collaboration diagram for solverTemplate:

Public Types
enum	solverType { stCompressible , stIncompressible , stBuoyant , stUnknown }
	Solver type. More...

Public Member Functions
	solverTemplate (const fileName &baseDir, const Time &runTime, const word &regionName)
	Constructor.
word	type () const
	Solver type name.
bool	multiRegion () const
	Return the multi-region flag.
label	nRegion () const
	Return the number of regions.
const word &	regionType (const label regionI) const
	Return the region type.
const word &	regionName (const label regionI) const
	Return the region name.
const wordList &	fieldNames (const label regionI) const
	Return the field names.
const wordList &	fieldTypes (const label regionI) const
	Return the field types.
const PtrList< dimensionSet > &	fieldDimensions (const label regionI) const
	Return the field dimensions.

Static Public Attributes
static const Enum< solverType >	solverTypeNames_
	Solver type names.

Detailed Description

Class to store solver template specifications.

Definition at line 47 of file solverTemplate.H.

Member Enumeration Documentation

◆ solverType

enum solverType

Solver type.

Enumerator
stCompressible
stIncompressible
stBuoyant
stUnknown

Definition at line 56 of file solverTemplate.H.

Constructor & Destructor Documentation

◆ solverTemplate()

solverTemplate	(	const fileName &	baseDir,
		const Time &	runTime,
		const word &	regionName )

Constructor.

References regionName(), and runTime.

Here is the call graph for this function:

Member Function Documentation

◆ type()

word type ( ) const

Solver type name.

◆ multiRegion()

bool multiRegion ( ) const

Return the multi-region flag.

◆ nRegion()

label nRegion ( ) const

Return the number of regions.

◆ regionType()

const word & regionType ( const label regionI ) const

Return the region type.

◆ regionName()

const word & regionName ( const label regionI ) const

Return the region name.

Referenced by solverTemplate().

Here is the caller graph for this function:

◆ fieldNames()

const wordList & fieldNames ( const label regionI ) const

Return the field names.

◆ fieldTypes()

const wordList & fieldTypes ( const label regionI ) const

Return the field types.

◆ fieldDimensions()

const PtrList< dimensionSet > & fieldDimensions ( const label regionI ) const

Return the field dimensions.

Member Data Documentation

◆ solverTypeNames_

const Enum<solverType> solverTypeNames_

static

Solver type names.

Definition at line 67 of file solverTemplate.H.

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

applications/utilities/preProcessing/createZeroDirectory/solverTemplate.H

Public Types

Public Member Functions

Static Public Attributes