Commit 39e0368d authored by Henry Weller's avatar Henry Weller
Browse files

functionObjects: Corrected member function documentation

parent 8b3b04b2
......@@ -106,7 +106,7 @@ public:
//- Read the CourantNo data
virtual bool read(const dictionary&);
//- Execute, currently does nothing
//- Calculate the Courant number
virtual bool execute(const bool postProcess = false);
};
......
......@@ -148,10 +148,10 @@ public:
//- Read the input data
virtual bool read(const dictionary&);
//- Execute, currently does nothing
//- Calculate the transformed fields
virtual bool execute(const bool postProcess = false);
//- Write
//- Write the transformed fields
virtual bool write(const bool postProcess = false);
};
......
......@@ -83,7 +83,7 @@ public:
// Member Functions
//- Execute, currently does nothing
//- Calculate the vorticity field
virtual bool execute(const bool postProcess = false);
};
......
......@@ -254,7 +254,7 @@ bool Foam::functionObjects::yPlus::write(const bool postProcess)
const volScalarField& yPlus =
obr_.lookupObject<volScalarField>(type());
if (log_) Info<< " writing field " << yPlus.name() << nl << endl;
if (log_) Info<< " writing field " << yPlus.name() << endl;
yPlus.write();
......
......@@ -120,10 +120,10 @@ public:
//- Read the yPlus data
virtual bool read(const dictionary&);
//- Execute, currently does nothing
//- Calculate the yPlus field
virtual bool execute(const bool postProcess = false);
//- Calculate the yPlus and write
//- Write the yPlus field
virtual bool write(const bool postProcess = false);
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment