Go to the documentation of this file.
99 #ifndef cellSetOption_H
100 #define cellSetOption_H
223 inline scalar
V() const noexcept;
232 inline scalar
timeStart(scalar val) noexcept;
235 inline scalar
duration(scalar val) noexcept;
258 #include "cellSetOptionI.H"
List< label > labelList
A List of labels.
void setVol()
Recalculate the volume.
const word & name() const noexcept
Return const access to the source name.
const labelList & cells() const noexcept
Return const access to the cell selection.
A class for handling words, derived from Foam::string.
Intermediate abstract class for handling cell-set options for the derived fvOptions.
cellSetOption(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
Construct from components.
selectionModeType selectionMode_
Cell selection mode.
virtual ~cellSetOption()=default
Destructor.
scalar V_
Sum of cell volumes.
void setCellSelection()
Set the cell selection based on user input selection mode.
bool inTimeLimits(const scalar timeValue) const
True if within time limits.
void setSelection(const dictionary &dict)
Set cell selection name or points selection from dictionary input.
scalar V() const noexcept
Return const access to the total cell volume.
Base abstract class for handling finite volume options (i.e. fvOption).
virtual bool isActive()
Is the source active?
virtual bool read(const dictionary &dict)
Read source dictionary.
bool useSubMesh() const noexcept
True if sub-selection should be used.
labelList cells_
Set of cells to apply source to.
TypeName("cellSetOption")
Runtime type information.
selectionModeType
Enumeration for selection mode types.
scalar duration() const noexcept
Return const access to the duration.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Mesh data needed to do the Finite Volume discretisation.
selectionModeType selectionMode() const noexcept
Return the cell selection mode.
static const Enum< selectionModeType > selectionModeTypeNames_
List of selection mode type names.
const fvMesh & mesh() const noexcept
Return const access to the mesh database.
const word & cellSetName() const noexcept
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
scalar duration_
Duration of fvOption execution starting from timeStart.
scalar timeStart() const noexcept
Return const access to the time start.
word cellSetName_
Name of set/zone for "cellSet" and "cellZone" selectionMode.
List< point > points_
List of points for "points" selectionMode.
scalar timeStart_
Start time of fvOption.