18725ed3ac
This changes simplifies the specification of functionObjects in controlDict and is consistent with the 'libs' option in controlDict to load special solver libraries. Support for the old 'functionObjectLibs' name is supported for backward compatibility.
180 lines
4.7 KiB
C++
180 lines
4.7 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 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::readFields
|
|
|
|
Group
|
|
grpFieldFunctionObjects
|
|
|
|
Description
|
|
This function object reads fields from the time directories and adds them to
|
|
the mesh database for further post-processing.
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
readFields1
|
|
{
|
|
type readFields;
|
|
libs ("libfieldFunctionObjects.so");
|
|
...
|
|
fields
|
|
(
|
|
U
|
|
p
|
|
);
|
|
}
|
|
\endverbatim
|
|
|
|
\heading Function object usage
|
|
\table
|
|
Property | Description | Required | Default value
|
|
type | type name: readFields | yes |
|
|
fields | list of fields to read | no |
|
|
\endtable
|
|
|
|
SeeAlso
|
|
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_;
|
|
|
|
//- Loaded fields
|
|
PtrList<volScalarField> vsf_;
|
|
PtrList<volVectorField> vvf_;
|
|
PtrList<volSphericalTensorField> vSpheretf_;
|
|
PtrList<volSymmTensorField> vSymmtf_;
|
|
PtrList<volTensorField> vtf_;
|
|
|
|
PtrList<surfaceScalarField> ssf_;
|
|
PtrList<surfaceVectorField> svf_;
|
|
PtrList<surfaceSphericalTensorField> sSpheretf_;
|
|
PtrList<surfaceSymmTensorField> sSymmtf_;
|
|
PtrList<surfaceTensorField> stf_;
|
|
|
|
|
|
// Protected Member Functions
|
|
|
|
template<class Type>
|
|
void loadField
|
|
(
|
|
const word&,
|
|
PtrList<GeometricField<Type, fvPatchField, volMesh>>&,
|
|
PtrList<GeometricField<Type, fvsPatchField, surfaceMesh>>&
|
|
) const;
|
|
|
|
|
|
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(const bool postProcess = false);
|
|
|
|
//- Do nothing
|
|
virtual bool write(const bool postProcess = false);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionObjects
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "readFieldsTemplates.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|