mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
166 lines
4.3 KiB
C++
166 lines
4.3 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2009-2009 OpenCFD Ltd.
|
|
\\/ 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 2 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, write to the Free Software Foundation,
|
|
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
Class
|
|
Foam::fieldValue
|
|
|
|
Description
|
|
Base class for field value -based function objects.
|
|
|
|
SourceFiles
|
|
fieldValue.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef fieldValue_H
|
|
#define fieldValue_H
|
|
|
|
#include "Switch.H"
|
|
#include "pointFieldFwd.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class dictionary;
|
|
class objectRegistry;
|
|
class fvMesh;
|
|
class mapPolyMesh;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class fieldValue Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class fieldValue
|
|
{
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Name of this fieldValue object
|
|
word name_;
|
|
|
|
//- Database this class is registered to
|
|
const objectRegistry& obr_;
|
|
|
|
//- Active flag
|
|
bool active_;
|
|
|
|
//- Switch to send output to Info as well as to file
|
|
Switch log_;
|
|
|
|
//- Name of source object
|
|
word sourceName_;
|
|
|
|
//- List of field names to operate on
|
|
wordList fields_;
|
|
|
|
//- Output field values flag
|
|
Switch valueOutput_;
|
|
|
|
|
|
// Functions to be over-ridden from IOoutputFilter class
|
|
|
|
//- Update mesh
|
|
virtual void updateMesh(const mapPolyMesh&);
|
|
|
|
//- Move points
|
|
virtual void movePoints(const Field<point>&);
|
|
|
|
|
|
public:
|
|
|
|
//- Run-time type information
|
|
TypeName("fieldValue");
|
|
|
|
|
|
//- Construct from components
|
|
fieldValue
|
|
(
|
|
const word& name,
|
|
const objectRegistry& obr,
|
|
const dictionary& dict,
|
|
const bool loadFromFiles = false
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~fieldValue();
|
|
|
|
|
|
// Public member functions
|
|
|
|
// Access
|
|
|
|
//- Return the name of the geometric source
|
|
const word& name() const;
|
|
|
|
//- Return the reference to the object registry
|
|
const objectRegistry& obr() const;
|
|
|
|
//- Return the active flag
|
|
bool active() const;
|
|
|
|
//- Return the switch to send output to Info as well as to file
|
|
const Switch& log() const;
|
|
|
|
//- Return the source name
|
|
const word& sourceName() const;
|
|
|
|
//- Return the list of field names
|
|
const wordList& fields() const;
|
|
|
|
//- Return the output field values flag
|
|
const Switch& valueOutput() const;
|
|
|
|
//- Helper function to return the reference to the mesh
|
|
const fvMesh& mesh() const;
|
|
|
|
|
|
// Function object functions
|
|
|
|
//- Read from dictionary
|
|
virtual void read(const dictionary& dict);
|
|
|
|
//- Execute
|
|
virtual void execute();
|
|
|
|
//- Execute the at the final time-loop, currently does nothing
|
|
virtual void end();
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|