helpBoundary Class Reference

Inheritance diagram for helpBoundary:

Collaboration diagram for helpBoundary:

Public Member Functions
	TypeName ("helpBoundary")
	helpBoundary ()
virtual	~helpBoundary ()
virtual void	init ()
virtual void	execute (const argList &args, const fvMesh &mesh)
Public Member Functions inherited from helpType
	TypeName ("helpType")
	declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),())
	helpType ()=default
virtual	~helpType ()=default

Protected Member Functions
template<class Type >
wordList	fieldConditions (const IOobject &io, const bool write) const
template<class Type >
void	fixedValueFieldConditions (const IOobject &io) const
Protected Member Functions inherited from helpType
fileName	doxygenPath () const
void	displayDocOptions (const string &searchStr, const bool exactMatch, const word &ext) const
void	displayDoc (const word &className, const string &searchStr, const bool exactMatch, const word &ext) const

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

Detailed Description

Definition at line 83 of file helpBoundary.H.

Constructor & Destructor Documentation

helpBoundary()

helpBoundary

(

)

~helpBoundary()

virtual ~helpBoundary ( )

virtual

Member Function Documentation

fieldConditions()

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

protected

fixedValueFieldConditions()

void fixedValueFieldConditions ( const IOobject &  io ) const

protected

TypeName()

TypeName

(

"helpBoundary"

)

init()

virtual void init ( )

virtual

Reimplemented from helpType.

execute()

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

virtual

Implements helpType.

---

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

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