Files
OpenFOAM-12/src/functionObjects/field/writeCellVolumes/writeCellVolumes.H
Henry Weller c01118589f functionObjects: Added fields() function to provide list of required fields to postProcess
With this change each functionObject provides the list of fields required so
that the postProcess utility can pre-load them before executing the list of
functionObjects.  This provides a more convenient interface than using the
-field or -fields command-line options to postProcess which are now redundant.
2021-10-21 09:23:34 +01:00

130 lines
3.4 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2021 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::writeCellVolumes
Description
Writes the cell-volumes volScalarField.
Example of function object specification:
\verbatim
writeCellVolumes
{
type writeCellVolumes;
libs ("libfieldFunctionObjects.so");
...
}
\endverbatim
Usage
\table
Property | Description | Required | Default value
type | type name: writeCellVolumes | yes |
\endtable
See also
Foam::functionObjects::fvMeshFunctionObject
SourceFiles
writeCellVolumes.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_writeCellVolumes_H
#define functionObjects_writeCellVolumes_H
#include "fvMeshFunctionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class writeCellVolumes Declaration
\*---------------------------------------------------------------------------*/
class writeCellVolumes
:
public fvMeshFunctionObject
{
public:
//- Runtime type information
TypeName("writeCellVolumes");
// Constructors
//- Construct from Time and dictionary
writeCellVolumes
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Disallow default bitwise copy construction
writeCellVolumes(const writeCellVolumes&) = delete;
//- Destructor
virtual ~writeCellVolumes();
// Member Functions
//- Return the list of fields required
virtual wordList fields() const
{
return wordList::null();
}
//- Do nothing
virtual bool execute();
//- Write the cell-centre fields
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const writeCellVolumes&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //