Go to the documentation of this file.
102 void constructMeshObjects();
161 const word& modelType,
175 const word& modelType,
254 inline bool active()
const;
virtual void writeFooter(Ostream &) const
Write the source footer information.
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
A special matrix type and solver, designed for finite area solutions of scalar equations....
A class for handling words, derived from Foam::string.
const word & name() const
Return const access to the source name.
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.
const word & regionName() const
Region name.
virtual void addSup(const areaScalarField &h, faMatrix< scalar > &eqn, const label fieldi)
const dictionary & coeffs() const
Return dictionary.
virtual void checkApplied() const
Check that the source has been applied.
const fvPatch & patch() const
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))
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.
autoPtr< faMesh > regionMeshPtr_
Pointer to the region mesh database.
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.
autoPtr< volSurfaceMapping > vsmPtr_
Volume-to surface mapping.
TypeName("option")
Runtime type information.
wordList fieldNames_
Field names to apply source to - populated by derived models.
Switch active_
Source active flag.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
bool active() const
Return const access to the source active flag.
const dimensionedScalar h
Planck constant.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
dictionary coeffs_
Dictionary containing source coefficients.
virtual ~option()=default
Destructor.
const faMesh & regionMesh() const
Return the region mesh database.
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.
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.
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.
const fvMesh & mesh() const
Return const access to the mesh database.
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.