Files
openfoam/src/functionObjects/field/readFields/readFields.H
2016-10-20 11:08:50 +01:00

160 lines
4.0 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | Copyright (C) 2015-2016 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::readFields
Group
grpFieldFunctionObjects
Description
Reads fields from the time directories and adds them to the mesh database
for further post-processing.
Usage
Example of function object specification:
\verbatim
readFields1
{
type readFields;
libs ("libfieldFunctionObjects.so");
...
fields (U p);
}
\endverbatim
Where the entries comprise:
\table
Property | Description | Required | Default value
type | type name: readFields | yes |
fields | list of fields to read | no |
log | Log to standard output | no | yes
\endtable
See also
Foam::functionObjects::fvMeshFunctionObject
SourceFiles
readFields.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_readFields_H
#define functionObjects_readFields_H
#include "fvMeshFunctionObject.H"
#include "volFieldsFwd.H"
#include "surfaceFieldsFwd.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class readFields Declaration
\*---------------------------------------------------------------------------*/
class readFields
:
public fvMeshFunctionObject
{
protected:
// Protected data
//- Fields to load
wordList fieldSet_;
// Protected Member Functions
template<class Type>
bool loadField(const word&);
private:
// Private member functions
//- Disallow default bitwise copy construct
readFields(const readFields&);
//- Disallow default bitwise assignment
void operator=(const readFields&);
public:
//- Runtime type information
TypeName("readFields");
// Constructors
//- Construct for given objectRegistry and dictionary.
// Allow the possibility to load fields from files
readFields
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- Destructor
virtual ~readFields();
// Member Functions
//- Read the set of fields from dictionary
virtual bool read(const dictionary&);
//- Read the fields
virtual bool execute();
//- Do nothing
virtual bool write();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "readFieldsTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //