Loading...
Searching...
No Matches
helpSolver Class Reference

#include <helpSolver.H>

Inheritance diagram for helpSolver:
Collaboration diagram for helpSolver:

Public Member Functions

 TypeName ("helpSolver")
 Runtime type information.
 helpSolver ()
 Constructor.
virtual ~helpSolver ()
 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.

Additional Inherited Members

Static Public Member Functions inherited from helpType
static autoPtr< helpTypeNew (const word &helpTypeName)
 Selector.
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.

Detailed Description

Definition at line 61 of file helpSolver.H.

Constructor & Destructor Documentation

◆ helpSolver()

helpSolver ( )

Constructor.

◆ ~helpSolver()

virtual ~helpSolver ( )
virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "helpSolver" )

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