Go to the documentation of this file.
101 void constructMeshObjects();
175 const word& modelType,
189 const word& modelType,
255 inline const word&
name() const noexcept;
267 inline
bool active() const noexcept;
285 inline
bool active(const
bool on) noexcept;
448 #include "faOptionI.H"
const word & regionName() const noexcept
The region name.
virtual void writeFooter(Ostream &) const
Write the source footer information.
A special matrix type and solver, designed for finite area solutions of scalar equations....
const word & name() const noexcept
Return const access to the source name.
A class for handling words, derived from Foam::string.
autoPtr< option > clone() const
Return clone.
virtual void constrain(faMatrix< scalar > &eqn, const label fieldi)
void setApplied(const label fieldi)
Set the applied flag to true for field index fieldi.
void resetApplied()
Resize/reset applied flag list for all fieldNames_ entries.
virtual void addSup(const areaScalarField &h, faMatrix< scalar > &eqn, const label fieldi)
Forward declarations of standard faMatrix types/specializations.
virtual void checkApplied() const
Check that the source has been applied.
const fvPatch & patch() const noexcept
Return const access to fvPatch.
option(const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
Construct from components.
static autoPtr< option > New(const word &name, const dictionary &dict, const fvPatch &patch)
Return a reference to the selected faOption model.
const word name_
Source name.
declareRunTimeSelectionTable(autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch),(name, modelType, dict, patch))
bool active() const noexcept
Return const access to the source active flag.
const fvMesh & mesh_
Reference to the mesh database.
virtual label applyToField(const word &fieldName) const
Return index of field name if found in fieldNames list.
List< word > wordList
A List of words.
iNew(const fvPatch &patch, const word &name)
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
virtual void writeData(Ostream &) const
Write the source properties.
TypeName("option")
Runtime type information.
wordList fieldNames_
Field names to apply source to - populated by derived models.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
const dimensionedScalar h
Planck constant.
Forwards and collection of common area field types.
const dictionary & coeffs() const noexcept
Return dictionary.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
dictionary coeffs_
Dictionary containing source coefficients.
bool log
Switch write log to Info.
virtual ~option()=default
Destructor.
const faMesh & regionMesh() const
Return the region mesh database (demand-driven)
virtual void writeHeader(Ostream &) const
Write the source header information.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
const volSurfaceMapping & vsm() const
Return volSurfaceMapping (demand-driven)
Mesh data needed to do the Finite Volume discretisation.
virtual bool read(const dictionary &dict)
Read source dictionary.
const fvPatch & patch_
Reference to the patch.
const word modelType_
Model type.
virtual bool isActive()
Is the source active?
word regionName_
Region name (finite-area)
const fvMesh & mesh() const noexcept
Return const access to the mesh database.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
virtual void correct(areaScalarField &field)
Macros to ease declaration of run-time selection tables.
Base abstract class for handling finite area options (i.e. faOption).
autoPtr< option > operator()(Istream &is) const
Volume to surface and surface to volume mapping.
Finite area mesh. Used for 2-D non-Euclidian finite area method.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
dictionary dict_
Top level source dictionary.
List< bool > applied_
Applied flag list - corresponds to each fieldNames_ entry.