Applies sources on either epsilon or omega to correct mixing-length scale estimations for atmospheric boundary layer modelling. More...

#include <atmLengthScaleTurbSource.H>

Inheritance diagram for atmLengthScaleTurbSource:

[legend]

Collaboration diagram for atmLengthScaleTurbSource:

[legend]

Public Member Functions
	TypeName ("atmLengthScaleTurbSource")
	Runtime type information.
	atmLengthScaleTurbSource (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh.
	atmLengthScaleTurbSource (const atmLengthScaleTurbSource &)=delete
	No copy construct.
void	operator= (const atmLengthScaleTurbSource &)=delete
	No copy assignment.
virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to epsilon or omega equation for incompressible flow computations.
virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to epsilon or omega equation for compressible flow computations.
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to epsilon or omega equation for multiphase flow computations.
virtual bool	read (const dictionary &dict)
	Read source dictionary (effectively no-op).
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< vector > &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< vector > &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< vector > &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 either epsilon or omega to correct mixing-length scale estimations for atmospheric boundary layer modelling.

Corrections applied to either of the below, if exist:

  epsilon   | Turbulent kinetic energy dissipation rate [m2/s3]
  omega     | Specific dissipation rate                 [1/s]

Required fields, either of the below:

  epsilon   | Turbulent kinetic energy dissipation rate [m2/s3]
  omega     | Specific dissipation rate                 [1/s]

References:

    Mixing-length scale limiter for epsilon (tag:AC):
        Apsley, D. D., & Castro, I. P. (1997).
        A limited-length-scale k-ε model for the neutral and
        stably-stratified atmospheric boundary layer.
        Boundary-layer meteorology, 83(1), 75-98.
        DOI:10.1023/A:1000252210512

    Mixing-length scale limiter for omega (tag:L):
        Langner, J. (2016).
        Implementierung und validierung von RANS-modellen der
        thermisch geschichteten, atmosphärischen grenzschicht.
        Masterarbeit zum thema, Technische Universität Berlin.

    Mixing-length scale estimation (tag:P):
        Pope, S. B. (2000).
        Turbulent flows.
        Cambridge, UK: Cambridge Univ. Press
        DOI:10.1017/CBO9780511840531

Usage

Example by using constant/fvOptions:

atmLengthScaleTurbSource1
{
    // Mandatory entries (unmodifiable)
    type                 atmLengthScaleTurbSource;

    atmLengthScaleTurbSourceCoeffs
    {
        // Mandatory (inherited) entries (unmodifiable)
        selectionMode    all;

        // Optional entries (unmodifiable)
        rho              rho;
        Lmax             41.575;
        n                3.0;
    }

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: atmLengthScaleTurbSource	word	yes	-
`rho`	Name of density field	word	no	rho
`Lmax`	Maximum mixing-length scale [m]	scalar	no	41.575
`n`	Mixing-length scale exponent	scalar	no	3.0

The inherited entries are elaborated in:

See also

cellSetOption.H

Source files

Definition at line 159 of file atmLengthScaleTurbSource.H.

Constructor & Destructor Documentation

◆ atmLengthScaleTurbSource() [1/2]

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

Construct from explicit source name and mesh.

Definition at line 75 of file atmLengthScaleTurbSource.C.

References cellSetOption::cellSetOption(), option::coeffs_, dict, Foam::dimLength, and option::mesh().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmLengthScaleTurbSource() [2/2]

atmLengthScaleTurbSource ( const atmLengthScaleTurbSource & )

delete

No copy construct.

References atmLengthScaleTurbSource().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "atmLengthScaleTurbSource" )

Runtime type information.

References dict, and option::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const atmLengthScaleTurbSource & )

delete

No copy assignment.

References alpha, atmLengthScaleTurbSource(), and rho.

Here is the call graph for this function:

◆ addSup() [1/3]

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

virtual

Add explicit contribution to epsilon or omega equation for incompressible flow computations.

Reimplemented from option.

Definition at line 170 of file atmLengthScaleTurbSource.C.

◆ addSup() [2/3]

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

virtual

Add explicit contribution to epsilon or omega equation for compressible flow computations.

Reimplemented from option.

Definition at line 199 of file atmLengthScaleTurbSource.C.

References rho.

◆ addSup() [3/3]

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

virtual

Add explicit contribution to epsilon or omega equation for multiphase flow computations.

Reimplemented from option.

Definition at line 217 of file atmLengthScaleTurbSource.C.

References alpha, and rho.

◆ read()

virtual bool read ( const dictionary & dict )

inlinevirtual

Read source dictionary (effectively no-op).

Reimplemented from cellSetOption.

Definition at line 311 of file atmLengthScaleTurbSource.H.

References dict.

The documentation for this class was generated from the following files:

src/atmosphericModels/fvOptions/atmLengthScaleTurbSource/atmLengthScaleTurbSource.H
src/atmosphericModels/fvOptions/atmLengthScaleTurbSource/atmLengthScaleTurbSource.C
src/atmosphericModels/fvOptions/atmLengthScaleTurbSource/atmLengthScaleTurbSourceTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atmLengthScaleTurbSource() [1/2]

◆ atmLengthScaleTurbSource() [2/2]

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ read()