Loading...
Searching...
No Matches
atmPlantCanopyUSource Class Reference
Numerics » Finite volume Options » Sources

Applies sources on velocity (i.e. U) to incorporate effects of plant canopy for atmospheric boundary layer modelling. More...

#include <atmPlantCanopyUSource.H>

Inheritance diagram for atmPlantCanopyUSource:
Inheritance graph
[legend]
Collaboration diagram for atmPlantCanopyUSource:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("atmPlantCanopyUSource")
 Runtime type information.
 atmPlantCanopyUSource (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from explicit source name and mesh.
 atmPlantCanopyUSource (const atmPlantCanopyUSource &)=delete
 No copy construct.
void operator= (const atmPlantCanopyUSource &)=delete
 No copy assignment.
virtual void addSup (fvMatrix< vector > &eqn, const label fieldi)
 Add explicit contribution to momentum equation.
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 Add explicit contribution to compressible momentum equation.
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 Add explicit contribution to phase momentum equation.
virtual bool read (const dictionary &dict)
 Read source dictionary.
Public Member Functions inherited from cellSetOption
 TypeName ("cellSetOption")
 Runtime type information.
 cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components.
virtual ~cellSetOption ()=default
 Destructor.
scalar timeStart () const noexcept
 Return const access to the time start.
scalar duration () const noexcept
 Return const access to the duration.
bool inTimeLimits (const scalar timeValue) const
 True if within time limits.
bool useSubMesh () const noexcept
 True if sub-selection should be used.
selectionModeType selectionMode () const noexcept
 Return the cell selection mode.
const wordRes & selectionNames () const noexcept
 Return const access to the selection names (set or zone selection).
const wordRe & zoneName () const
 Return const access to the first set/zone name.
scalar V () const noexcept
 Return const access to the total cell volume.
const labelList & cells () const noexcept
 Return const access to the cell selection.
bool isSelectionUpdated () const noexcept
 Return flag for selection updates.
scalar timeStart (scalar val) noexcept
 Adjust the time start, return the old value.
scalar duration (scalar val) noexcept
 Adjust the duration, return the old value.
virtual bool isActive ()
 Is the source active?
const word & cellSetName () const
 The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes).
Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
 option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components.
autoPtr< option > clone () const
 Return clone.
virtual ~option ()=default
 Destructor.
const word & name () const noexcept
 Return const access to the source name.
const fvMesh & mesh () const noexcept
 Return const access to the mesh database.
const dictionary & coeffs () const noexcept
 Return dictionary.
bool active () const noexcept
 True if source is active.
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi.
bool active (const bool on) noexcept
 Change source active flag, return previous value.
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list.
virtual void checkApplied () const
 Check that the source has been applied.
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldi)
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldi)
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
virtual void constrain (fvMatrix< scalar > &eqn, const label fieldi)
virtual void constrain (fvMatrix< vector > &eqn, const label fieldi)
virtual void constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void constrain (fvMatrix< tensor > &eqn, const label fieldi)
virtual void correct (volScalarField &field)
virtual void correct (volVectorField &field)
virtual void correct (volSphericalTensorField &field)
virtual void correct (volSymmTensorField &field)
virtual void correct (volTensorField &field)
virtual void correct (surfaceScalarField &field)
virtual void correct (surfaceVectorField &field)
virtual void correct (surfaceTensorField &field)
virtual void postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void writeHeader (Ostream &) const
 Write the source header information.
virtual void writeFooter (Ostream &) const
 Write the source footer information.
virtual void writeData (Ostream &) const
 Write the source properties.

Additional Inherited Members

Public Types inherited from cellSetOption
enum  selectionModeType : char {
  smAll , smCellSet , smCellZone , smPoints ,
  smMovingPoints , smGeometric , smCellType
}
 Enumeration for selection mode types. More...
Static Public Member Functions inherited from option
static autoPtr< option > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model.
Public Attributes inherited from option
bool log
 Switch write log to Info.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType > selectionModeTypeNames_
 List of selection mode type names.
Protected Member Functions inherited from cellSetOption
void setSelection (const dictionary &dict)
 Set cell selection name or points selection from dictionary input.
void setCellSelection ()
 Set the cell selection based on user input selection mode.
void setVol ()
 Recalculate the volume.
Protected Member Functions inherited from option
void resetApplied ()
 Resize/reset applied flag list for all fieldNames_ entries.
Protected Attributes inherited from cellSetOption
selectionModeType selectionMode_
 Cell selection mode.
bool updateSelection_
 Flag to enable dictionary-based updates of selections.
scalar timeStart_
 Start time of fvOption.
scalar duration_
 Duration of fvOption execution starting from timeStart.
wordRes selectionNames_
 Face selection names (for set or zone selections).
List< point > points_
 List of points for "points" selectionMode.
PtrList< Function1< point > > movingPoints_
 List of points for "movingPoints" selectionMode.
dictionary geometricSelection_
 Dictionary entries for "geometric" (topoSetCellSource) selection.
labelList cells_
 Set of cells to apply source to.
scalar V_
 Sum of cell volumes.
Protected Attributes inherited from option
const word name_
 Source name.
const word modelType_
 Model type.
const fvMesh & mesh_
 Reference to the mesh database.
dictionary dict_
 Top level source dictionary.
dictionary coeffs_
 Dictionary containing source coefficients.
wordList fieldNames_
 Field names to apply source to - populated by derived models.
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry.
bool active_
 Source active flag.

Detailed Description

Applies sources on velocity (i.e. U) to incorporate effects of plant canopy for atmospheric boundary layer modelling.

Corrections applied to: 

  U                | Velocity                               [m/s]

Required fields: 

  U                | Velocity                               [m/s]
  Cd               | Plant canopy drag coefficient          [-]
  LAD              | Leaf area density                      [1/m]

References: 

    Influence of forest (tag:SP):
        Sogachev, A., & Panferov, O. (2006).
        Modification of two-equation models to account for plant drag.
        Boundary-Layer Meteorology, 121(2), 229-266.
        DOI:10.1007/s10546-006-9073-5

    Governing equations (tag:BSG):
        Brozovsky, J., Simonsen, A., & Gaitani, N. (2021).
        Validation of a CFD model for the evaluation of urban microclimate
        at high latitudes: A case study in Trondheim, Norway.
        Building and Environment, 205, 108175.
        DOI:10.1016/j.buildenv.2021.108175
Usage
Example by using constant/fvOptions: 
atmPlantCanopyUSource1
{
    // Mandatory entries
    type         atmPlantCanopyUSource;

    // Optional entries
    Cd           <word>;
    LAD          <word>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: atmPlantCanopyUSource word yes -
Cd Name of operand canopy drag coefficient field word no Cd
LAD Name of operand leaf area density field word no LAD

The inherited entries are elaborated in:

Source files

Definition at line 136 of file atmPlantCanopyUSource.H.

Constructor & Destructor Documentation

◆ atmPlantCanopyUSource() [1/2]

atmPlantCanopyUSource ( const word & sourceName,
const word & modelType,
const dictionary & dict,
const fvMesh & mesh )

Construct from explicit source name and mesh.

Definition at line 71 of file atmPlantCanopyUSource.C.

References cellSetOption::cellSetOption(), dict, Foam::endl(), option::fieldNames_, Log, option::mesh(), read(), and option::resetApplied().

Referenced by atmPlantCanopyUSource(), and operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ atmPlantCanopyUSource() [2/2]

atmPlantCanopyUSource ( const atmPlantCanopyUSource & )
delete

No copy construct.

References atmPlantCanopyUSource().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "atmPlantCanopyUSource" )

Runtime type information.

References dict, and option::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const atmPlantCanopyUSource & )
delete

No copy assignment.

References alpha, atmPlantCanopyUSource(), dict, and rho.

Here is the call graph for this function:

◆ addSup() [1/3]

void addSup ( fvMatrix< vector > & eqn,
const label fieldi )
virtual

Add explicit contribution to momentum equation.

Reimplemented from option.

Definition at line 95 of file atmPlantCanopyUSource.C.

References Foam::mag(), fvMatrix< Type >::psi(), Foam::fvm::Sp(), U, and cellSetOption::V_.

Here is the call graph for this function:

◆ addSup() [2/3]

void addSup ( const volScalarField & rho,
fvMatrix< vector > & eqn,
const label fieldi )
virtual

Add explicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 115 of file atmPlantCanopyUSource.C.

References Foam::mag(), fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), U, and cellSetOption::V_.

Here is the call graph for this function:

◆ addSup() [3/3]

void addSup ( const volScalarField & alpha,
const volScalarField & rho,
fvMatrix< vector > & eqn,
const label fieldi )
virtual

Add explicit contribution to phase momentum equation.

Reimplemented from option.

Definition at line 135 of file atmPlantCanopyUSource.C.

References alpha, Foam::mag(), fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), U, and cellSetOption::V_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict)
virtual

Read source dictionary.

Reimplemented from cellSetOption.

Definition at line 156 of file atmPlantCanopyUSource.C.

References dict, and cellSetOption::read().

Referenced by atmPlantCanopyUSource().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: