Go to the documentation of this file.
165 const word& modelType,
230 inline const word&
name() const noexcept;
239 inline
bool active() const noexcept;
248 inline
bool active(const
bool on) noexcept;
427 const
word& designVariablesName =
word::null
433 const
word& designVariablesName =
word::null
439 const
word& designVariablesName =
word::null
466 #include "fvOptionI.H"
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))
const word & name() const noexcept
Return const access to the source name.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
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.
void resetApplied()
Resize/reset applied flag list for all fieldNames_ entries.
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
Forward declarations of fvMatrix specializations.
const word name_
Source name.
const fvMesh & mesh_
Reference to the mesh database.
List< word > wordList
A List of words.
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.
bool active() const noexcept
True if source is active.
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)
Base abstract class for handling finite volume options (i.e. fvOption).
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
const dictionary & coeffs() const noexcept
Return dictionary.
dictionary coeffs_
Dictionary containing source coefficients.
TypeName("option")
Runtime type information.
wordList fieldNames_
Field names to apply source to - populated by derived models.
virtual ~option()=default
Destructor.
bool log
Switch write log to Info.
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 void postProcessSens(scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
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.
const fvMesh & mesh() const noexcept
Return const access to the mesh database.
Macros to ease declaration of run-time selection tables.
bool active_
Source active flag.
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.