67 const string& searchStr,
68 const bool exactMatch,
75 const word& className,
76 const string& searchStr,
77 const bool exactMatch,
Extract command arguments and options from the supplied argc and argv parameters.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
A class for handling file names.
Mesh data needed to do the Finite Volume discretisation.
Base class for foam help classes.
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.
TypeName("helpType")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, helpType, dictionary,(),())
void displayDoc(const word &className, const string &searchStr, const bool exactMatch, const word &ext) const
Display the help documentation in a browser.
helpType()=default
Default construct.
virtual void init()
Initialise - typically setting static variables,.
virtual ~helpType()=default
Destructor.
virtual void execute(const argList &args, const fvMesh &mesh)=0
Execute the help.
static autoPtr< helpType > New(const word &helpTypeName)
Selector.
A class for handling words, derived from Foam::string.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
Foam::argList args(argc, argv)
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.