functionObjects: Corrected member function documentation

This commit is contained in:
Henry Weller
2016-05-22 21:28:24 +01:00
parent da1c026f67
commit 2e399d34bc
5 changed files with 7 additions and 7 deletions

View File

@ -106,7 +106,7 @@ public:
//- Read the CourantNo data //- Read the CourantNo data
virtual bool read(const dictionary&); virtual bool read(const dictionary&);
//- Execute, currently does nothing //- Calculate the Courant number
virtual bool execute(const bool postProcess = false); virtual bool execute(const bool postProcess = false);
}; };

View File

@ -148,10 +148,10 @@ public:
//- Read the input data //- Read the input data
virtual bool read(const dictionary&); virtual bool read(const dictionary&);
//- Execute, currently does nothing //- Calculate the transformed fields
virtual bool execute(const bool postProcess = false); virtual bool execute(const bool postProcess = false);
//- Write //- Write the transformed fields
virtual bool write(const bool postProcess = false); virtual bool write(const bool postProcess = false);
}; };

View File

@ -83,7 +83,7 @@ public:
// Member Functions // Member Functions
//- Execute, currently does nothing //- Calculate the vorticity field
virtual bool execute(const bool postProcess = false); virtual bool execute(const bool postProcess = false);
}; };

View File

@ -254,7 +254,7 @@ bool Foam::functionObjects::yPlus::write(const bool postProcess)
const volScalarField& yPlus = const volScalarField& yPlus =
obr_.lookupObject<volScalarField>(type()); obr_.lookupObject<volScalarField>(type());
if (log_) Info<< " writing field " << yPlus.name() << nl << endl; if (log_) Info<< " writing field " << yPlus.name() << endl;
yPlus.write(); yPlus.write();

View File

@ -120,10 +120,10 @@ public:
//- Read the yPlus data //- Read the yPlus data
virtual bool read(const dictionary&); virtual bool read(const dictionary&);
//- Execute, currently does nothing //- Calculate the yPlus field
virtual bool execute(const bool postProcess = false); virtual bool execute(const bool postProcess = false);
//- Calculate the yPlus and write //- Write the yPlus field
virtual bool write(const bool postProcess = false); virtual bool write(const bool postProcess = false);
}; };