helpFunctionObject Class Reference

Inheritance diagram for helpFunctionObject:

Collaboration diagram for helpFunctionObject:

Public Member Functions
	TypeName ("helpFunctionObject")
	helpFunctionObject ()
virtual	~helpFunctionObject ()
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

Additional Inherited Members
Static Public Member Functions inherited from helpType
static autoPtr< helpType >	New (const word &helpTypeName)
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

Detailed Description

Definition at line 62 of file helpFunctionObject.H.

Constructor & Destructor Documentation

helpFunctionObject()

helpFunctionObject

(

)

~helpFunctionObject()

virtual ~helpFunctionObject ( )

virtual

Member Function Documentation

TypeName()

TypeName

(

"helpFunctionObject"

)

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/helpFunctionObject/helpFunctionObject.H