Go to the documentation of this file.
118 const word& modelType,
132 const word& modelType,
207 inline bool active()
const;
virtual void correct(volScalarField &field)
declareRunTimeSelectionTable(autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
void setApplied(const label fieldi)
Set the applied flag to true for field index fieldi.
A class for handling words, derived from Foam::string.
autoPtr< option > clone() const
Return clone.
const word & name() const
Return const access to the source name.
virtual void checkApplied() const
Check that the source has been applied.
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
autoPtr< option > operator()(Istream &is) const
const dictionary & coeffs() const
Return dictionary.
Forward declarations of fvMatrix specializations.
const word name_
Source name.
const fvMesh & mesh_
Reference to the mesh database.
virtual void writeData(Ostream &) const
Write the source properties.
virtual label applyToField(const word &fieldName) const
Return index of field name if found in fieldNames list.
option(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
Construct from components.
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
virtual void addSup(fvMatrix< scalar > &eqn, const label fieldi)
Finite volume options abstract base class. Provides a base set of controls, e.g.:
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Switch active_
Source active flag.
dictionary coeffs_
Dictionary containing source coefficients.
TypeName("option")
Runtime type information.
wordList fieldNames_
Field names to apply source to - populated by derived models.
bool active() const
Return const access to the source active flag.
virtual ~option()=default
Destructor.
bool log
Switch write log to Info.
Return pointer to new fvOption object created.
virtual void constrain(fvMatrix< scalar > &eqn, const label fieldi)
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
virtual void writeHeader(Ostream &) const
Write the source header information.
Mesh data needed to do the Finite Volume discretisation.
static autoPtr< option > New(const word &name, const dictionary &dict, const fvMesh &mesh)
Return a reference to the selected fvOption model.
virtual bool read(const dictionary &dict)
Read source dictionary.
virtual bool isActive()
Is the source active?
const word modelType_
Model type.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Macros to ease declaration of run-time selection tables.
const fvMesh & mesh() const
Return const access to the mesh database.
A special matrix type and solver, designed for finite volume solutions of scalar equations....
dictionary dict_
Top level source dictionary.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
List< bool > applied_
Applied flag list - corresponds to each fieldNames_ entry.
iNew(const fvMesh &mesh, const word &name)
virtual void writeFooter(Ostream &) const
Write the source footer information.