solverTemplate Class Reference

Class to store solver template specifications. More...

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. More...
word	type () const
	Solver type name. More...
bool	multiRegion () const
	Return the multi-region flag. More...
label	nRegion () const
	Return the number of regions. More...
const word &	regionType (const label regionI) const
	Return the region type. More...
const word &	regionName (const label regionI) const
	Return the region name. More...
const wordList &	fieldNames (const label regionI) const
	Return the field names. More...
const wordList &	fieldTypes (const label regionI) const
	Return the field types. More...
const PtrList< dimensionSet > &	fieldDimensions (const label regionI) const
	Return the field dimensions. More...

Static Public Attributes
static const NamedEnum< solverType, 4 >	solverTypeNames_
	Solver type names. More...

Private Member Functions
word	readFromDict (IOobject &dictHeader, const word &entryName) const
	Read a word from a dictionary (offers some protection...) More...
dictionary	readFluidFieldTemplates (const word &regionName, const fileName &baseDir, const dictionary &solverDict, const Time &runTime) const
	Read fluid region templates. More...
dictionary	readSolidFieldTemplates (const word &regionName, const dictionary &solverDict) const
	Read solid region templates. More...
void	setRegionProperties (const dictionary &dict, const word &regionType, const word &regionName, const label regionI)
	Set the properties for region with index regionI. More...

Private Attributes
solverType	solverType_
	Solver type. More...
bool	multiRegion_
	Multi-region flag. More...
wordList	regionTypes_
	Region types. More...
wordList	regionNames_
	Region names. More...
List< wordList >	fieldNames_
	Field names. More...
List< wordList >	fieldTypes_
	Field types. More...
List< PtrList< dimensionSet > >	fieldDimensions_
	Field dimensions. More...

Detailed Description

Class to store solver template specifications.

Definition at line 51 of file solverTemplate.H.

Member Enumeration Documentation

solverType

enum solverType

Solver type.

Enumerator
stCompressible
stIncompressible
stBuoyant
stUnknown

Definition at line 58 of file solverTemplate.H.

Constructor & Destructor Documentation

solverTemplate()

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

Constructor.

Member Function Documentation

readFromDict()

word readFromDict ( IOobject &  dictHeader, const word &  entryName  ) const

private

Read a word from a dictionary (offers some protection...)

readFluidFieldTemplates()

dictionary readFluidFieldTemplates ( const word &  regionName, const fileName &  baseDir, const dictionary &  solverDict, const Time &  runTime  ) const

private

Read fluid region templates.

readSolidFieldTemplates()

dictionary readSolidFieldTemplates ( const word &  regionName, const dictionary &  solverDict  ) const

private

Read solid region templates.

setRegionProperties()

void setRegionProperties ( const dictionary &  dict, const word &  regionType, const word &  regionName, const label  regionI  )

private

Set the properties for region with index regionI.

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.

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.

Field Documentation

solverTypeNames_

const NamedEnum<solverType, 4> solverTypeNames_

static

Solver type names.

Definition at line 67 of file solverTemplate.H.

solverType_

solverType solverType_

private

Solver type.

Definition at line 75 of file solverTemplate.H.

multiRegion_

bool multiRegion_

private

Multi-region flag.

Definition at line 78 of file solverTemplate.H.

regionTypes_

wordList regionTypes_

private

Region types.

Definition at line 84 of file solverTemplate.H.

regionNames_

wordList regionNames_

private

Region names.

Definition at line 87 of file solverTemplate.H.

fieldNames_

List<wordList> fieldNames_

private

Field names.

Definition at line 90 of file solverTemplate.H.

fieldTypes_

List<wordList> fieldTypes_

private

Field types.

Definition at line 93 of file solverTemplate.H.

fieldDimensions_

List<PtrList<dimensionSet> > fieldDimensions_

private

Field dimensions.

Definition at line 96 of file solverTemplate.H.

---

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

• applications/utilities/preProcessing/createZeroDirectory/solverTemplate.H