helpBoundary Class Reference

#include <helpBoundary.H>

Inheritance diagram for helpBoundary:

Collaboration diagram for helpBoundary:

Public Member Functions
	TypeName ("helpBoundary")
	Runtime type information.
	helpBoundary ()
	Constructor.
virtual	~helpBoundary ()
	Destructor.
virtual void	init ()
	Initialise - typically setting static variables,.
virtual void	execute (const argList &args, const fvMesh &mesh)
	Execute the help.
Public Member Functions inherited from helpType
	TypeName ("helpType")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),())
	helpType ()=default
	Default construct.
virtual	~helpType ()=default
	Destructor.

Protected Member Functions
template<class Type>
wordList	fieldConditions (const IOobject &io, const bool write) const
	Return/output the available boundary conditions for fields of Type.
template<class Type>
void	fixedValueFieldConditions (const IOobject &io) const
	Output the available fixed boundary conditions for fields of Type.
Protected Member Functions inherited from helpType
fileName	doxygenPath () const
	Return file path to the Doxygen sources (if available).
void	displayDocOptions (const string &searchStr, const bool exactMatch, const word &ext) const
	Display the list of documentation options.
void	displayDoc (const word &className, const string &searchStr, const bool exactMatch, const word &ext) const
	Display the help documentation in a browser.

Additional Inherited Members
Static Public Member Functions inherited from helpType
static autoPtr< helpType >	New (const word &helpTypeName)
	Selector.

Detailed Description

Definition at line 83 of file helpBoundary.H.

Constructor & Destructor Documentation

helpBoundary()

helpBoundary

(

)

Constructor.

~helpBoundary()

virtual ~helpBoundary ( )

virtual

Destructor.

Member Function Documentation

fieldConditions()

template<class Type>

wordList fieldConditions ( const IOobject & io, const bool write ) const

protected

Return/output the available boundary conditions for fields of Type.

References io, and write().

Here is the call graph for this function:

fixedValueFieldConditions()

template<class Type>

void fixedValueFieldConditions ( const IOobject & io ) const

protected

Output the available fixed boundary conditions for fields of Type.

References io.

TypeName()

TypeName

(

"helpBoundary"

)

Runtime type information.

init()

virtual void init ( )

virtual

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented from helpType.

execute()

virtual void execute ( const argList & args, const fvMesh & mesh )

virtual

Execute the help.

Implements helpType.

References args, and mesh.

---

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

• applications/utilities/miscellaneous/foamHelp/helpTypes/helpBoundary/helpBoundary.H