Class to store boundary template specifications. More...

Collaboration diagram for boundaryTemplates:

Public Member Functions
	boundaryTemplates (const fileName &baseDir, const Time &runTime, const word &solverType)
	Constructor. More...

const dictionary &	templates () const
	Return the dictionary of boundary templates. More...

dictionary	generatePatchDict (const word &regionPrefix, const word &fieldName, const word &condition, const word &category, const word &patchType, const dictionary &conditionOptions) const
	Generate a dictionary representation of patch boundary condition. More...

void	checkPatch (const word &regionPrefix, const word &condition, const word &category, const word &patchType) const
	Check that user supplied patch info is valid. More...

bool	optionsRequired (const word &regionPrefix, const word &category, const word &patchType) const
	Return true if condition requires additional user options. More...

Private Attributes
dictionary	templates_
	Dictionary of boundary templates. More...

dictionary	options_
	Dictionary of boundary template options. More...

Detailed Description

Class to store boundary template specifications.

Templates are typically stored centrally, and constructed in a hierarchical manner. The main use is to convert the (user) specified conditions into a form which can be inserted into each field file as dictionary entries.

Definition at line 53 of file boundaryTemplates.H.

Constructor & Destructor Documentation

◆ boundaryTemplates()

boundaryTemplates	(	const fileName &	baseDir,
		const Time &	runTime,
		const word &	solverType
	)

Constructor.

Member Function Documentation

◆ templates()

const dictionary& templates ( ) const

Return the dictionary of boundary templates.

◆ generatePatchDict()

dictionary generatePatchDict	(	const word &	regionPrefix,
		const word &	fieldName,
		const word &	condition,
		const word &	category,
		const word &	patchType,
		const dictionary &	conditionOptions
	)		const

Generate a dictionary representation of patch boundary condition.

◆ checkPatch()

void checkPatch	(	const word &	regionPrefix,
		const word &	condition,
		const word &	category,
		const word &	patchType
	)		const

Check that user supplied patch info is valid.

◆ optionsRequired()

bool optionsRequired	(	const word &	regionPrefix,
		const word &	category,
		const word &	patchType
	)		const

Return true if condition requires additional user options.

Field Documentation

◆ templates_

dictionary templates_

private

Dictionary of boundary templates.

Definition at line 58 of file boundaryTemplates.H.

◆ options_

dictionary options_