Constrain temperature equation (i.e. T) with a given set of fixed values within a specified region. More...

#include <fixedTemperatureConstraint.H>

Inheritance diagram for fixedTemperatureConstraint:

Collaboration diagram for fixedTemperatureConstraint:

[legend]

Public Types
enum	temperatureMode { tmUniform , tmLookup }
	Temperature mode. More...
Public Types inherited from cellSetOption
enum	selectionModeType : char { smAll , smCellSet , smCellZone , smPoints , smMovingPoints , smGeometric , smCellType }
	Enumeration for selection mode types. More...

Public Member Functions
	TypeName ("fixedTemperatureConstraint")
	Runtime type information.
	fixedTemperatureConstraint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	fixedTemperatureConstraint (const fixedTemperatureConstraint &)=delete
	No copy construct.
void	operator= (const fixedTemperatureConstraint &)=delete
	No copy assignment.
virtual	~fixedTemperatureConstraint ()=default
	Destructor.
virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)
	Constrain energy equation to fix the temperature.
virtual bool	read (const dictionary &dict)
	Read 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< 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< scalar > &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< scalar > &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< 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.

Static Public Attributes
static const Enum< temperatureMode >	temperatureModeNames_
	String representation of temperatureMode enums.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names.

Protected Attributes
temperatureMode	mode_
	Operation mode.
autoPtr< Function1< scalar > >	Tuniform_
	Uniform temperature [K].
word	TName_
	Temperature field name.
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.

Additional Inherited Members
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.
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.

Detailed Description

Constrain temperature equation (i.e. T) with a given set of fixed values within a specified region.

Constraints applied to:

  T    | Temperature                   [K]

Required fields:

  T    | Temperature                   [K]
  e/h  | Internal energy/Enthalphy     [m2/s2]

Usage

Minimal example by using constant/fvOptions:

fixedTemperatureConstraint1
{
    // Mandatory entries (unmodifiable)
    type            fixedTemperatureConstraint;
    mode            <mode>;

    // Conditional mandatory/optional entries (runtime modifiable)

        // when mode=uniform (mandatory)
        temperature     constant 500; // fixed temperature with time [K]

        // when mode=lookup (optional)
        T            <Tname>;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: fixedTemperatureConstraint	word	yes	-
`mode`	Temperature mode - see below	word	yes	-
`temperature`	Function1 type temperature field	Function1	cndtnl	-
`T`	Name of operand temperature field	word	cndtnl	T

Options for the mode entry:

      uniform | Use Function1 type temperature field
      lookup  | Use temperature field given field name

The inherited entries are elaborated in:

Note:

The uniform option allows the use of a time-varying uniform temperature by means of the Function1 type.

See also

Source files

Definition at line 145 of file fixedTemperatureConstraint.H.

Member Enumeration Documentation

◆ temperatureMode

enum temperatureMode

Temperature mode.

Enumerator
tmUniform
tmLookup

Definition at line 154 of file fixedTemperatureConstraint.H.

Constructor & Destructor Documentation

◆ fixedTemperatureConstraint() [1/2]

fixedTemperatureConstraint	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh )

Construct from components.

Definition at line 57 of file fixedTemperatureConstraint.C.

References cellSetOption::cellSetOption(), option::coeffs_, dict, basicThermo::dictName, option::fieldNames_, option::mesh(), option::mesh_, mode_, option::name(), option::resetApplied(), temperatureModeNames_, tmLookup, tmUniform, TName_, and Tuniform_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixedTemperatureConstraint() [2/2]

fixedTemperatureConstraint ( const fixedTemperatureConstraint & )

delete

No copy construct.

References fixedTemperatureConstraint().

Here is the call graph for this function:

◆ ~fixedTemperatureConstraint()

virtual ~fixedTemperatureConstraint ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedTemperatureConstraint" )

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const fixedTemperatureConstraint & )

delete

No copy assignment.

References fixedTemperatureConstraint().

Here is the call graph for this function:

◆ constrain()

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

virtual

Constrain energy equation to fix the temperature.

Reimplemented from option.

Definition at line 105 of file fixedTemperatureConstraint.C.

References cellSetOption::cells_, basicThermo::dictName, mesh, option::mesh_, mode_, fvMatrix< Type >::setValues(), Foam::T(), tmLookup, tmUniform, TName_, and Tuniform_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 140 of file fixedTemperatureConstraint.C.

References option::coeffs_, dict, keyType::LITERAL, option::mesh_, cellSetOption::read(), TName_, and Tuniform_.

Here is the call graph for this function:

Member Data Documentation

◆ temperatureModeNames_

const Foam::Enum< Foam::fv::fixedTemperatureConstraint::temperatureMode > temperatureModeNames_

static

String representation of temperatureMode enums.

Definition at line 163 of file fixedTemperatureConstraint.H.

Referenced by fixedTemperatureConstraint().

◆ mode_

temperatureMode mode_

protected

Operation mode.

Definition at line 173 of file fixedTemperatureConstraint.H.

Referenced by constrain(), and fixedTemperatureConstraint().

◆ Tuniform_

autoPtr<Function1<scalar> > Tuniform_

protected

Uniform temperature [K].

Definition at line 178 of file fixedTemperatureConstraint.H.

Referenced by constrain(), fixedTemperatureConstraint(), and read().

◆ TName_

word TName_

protected

Temperature field name.

Definition at line 183 of file fixedTemperatureConstraint.H.

Referenced by constrain(), fixedTemperatureConstraint(), and read().

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

src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.H
src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.C

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ temperatureMode

Constructor & Destructor Documentation

◆ fixedTemperatureConstraint() [1/2]

◆ fixedTemperatureConstraint() [2/2]

◆ ~fixedTemperatureConstraint()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ constrain()

◆ read()

Member Data Documentation

◆ temperatureModeNames_

◆ mode_

◆ Tuniform_

◆ TName_