This boundary condition provides an outflow condition for total temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow. More...

Inheritance diagram for inletOutletTotalTemperatureFvPatchScalarField:

[legend]

Collaboration diagram for inletOutletTotalTemperatureFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("inletOutletTotalTemperature")
	Runtime type information. More...

	inletOutletTotalTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...

	inletOutletTotalTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	inletOutletTotalTemperatureFvPatchScalarField (const inletOutletTotalTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	inletOutletTotalTemperatureFvPatchScalarField (const inletOutletTotalTemperatureFvPatchScalarField &)
	Construct as copy. More...

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	inletOutletTotalTemperatureFvPatchScalarField (const inletOutletTotalTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const scalarField &	T0 () const
	Return the total pressure. More...

scalarField &	T0 ()
	Return reference to the total pressure to allow adjustment. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Private Attributes
word	UName_
	Name of the velocity field. More...

word	psiName_
	Name of the compressibility field used to calculate the wave speed. More...

scalar	gamma_
	Heat capacity ratio. More...

scalarField	T0_
	Total pressure. More...

Detailed Description

This boundary condition provides an outflow condition for total temperature for use with supersonic cases, where a user-specified value is applied in the case of reverse flow.

Patch usage

Property	Description	Required	Default value
`U`	velocity field name	no	U
`phi`	flux field name	no	phi
`psi`	compressibility field name	no	psi
`gamma`	heat capacity ration (Cp/Cv)	yes
`inletValue`	reverse flow (inlet) value	yes
`T0`	static temperature [K]	yes

Example of the boundary condition specification:

    myPatch
    {
        type            inletOutletTotalTemperature;
        U               U;
        phi             phi;
        psi             psi;
        gamma           gamma;
        inletValue      uniform 0;
        T0              uniform 0;
        value           uniform 0;
    }

See also: Foam::inletOutletFvPatchField

Source files

Definition at line 118 of file inletOutletTotalTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ inletOutletTotalTemperatureFvPatchScalarField() [1/5]

inletOutletTotalTemperatureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 36 of file inletOutletTotalTemperatureFvPatchScalarField.C.

Referenced by inletOutletTotalTemperatureFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ inletOutletTotalTemperatureFvPatchScalarField() [2/5]

inletOutletTotalTemperatureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 72 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References dict, p, and scalarField().

Here is the call graph for this function:

◆ inletOutletTotalTemperatureFvPatchScalarField() [3/5]

inletOutletTotalTemperatureFvPatchScalarField	(	const inletOutletTotalTemperatureFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

inletOutletTotalTemperatureFvPatchScalarField onto a new patch

Definition at line 55 of file inletOutletTotalTemperatureFvPatchScalarField.C.

◆ inletOutletTotalTemperatureFvPatchScalarField() [4/5]

inletOutletTotalTemperatureFvPatchScalarField ( const inletOutletTotalTemperatureFvPatchScalarField & tppsf )

Construct as copy.

Definition at line 106 of file inletOutletTotalTemperatureFvPatchScalarField.C.

◆ inletOutletTotalTemperatureFvPatchScalarField() [5/5]

inletOutletTotalTemperatureFvPatchScalarField	(	const inletOutletTotalTemperatureFvPatchScalarField &	tppsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 120 of file inletOutletTotalTemperatureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "inletOutletTotalTemperature" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 177 of file inletOutletTotalTemperatureFvPatchScalarField.H.

References inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 194 of file inletOutletTotalTemperatureFvPatchScalarField.H.

References inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ T0() [1/2]

const scalarField& T0 ( ) const

inline

Return the total pressure.

Definition at line 210 of file inletOutletTotalTemperatureFvPatchScalarField.H.

References inletOutletTotalTemperatureFvPatchScalarField::T0_.

◆ T0() [2/2]

scalarField& T0 ( )

inline

Return reference to the total pressure to allow adjustment.

Definition at line 216 of file inletOutletTotalTemperatureFvPatchScalarField.H.

References inletOutletTotalTemperatureFvPatchScalarField::T0_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 136 of file inletOutletTotalTemperatureFvPatchScalarField.C.

◆ rmap()

void rmap	(	const fvPatchScalarField &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 146 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References inletOutletTotalTemperatureFvPatchScalarField::T0_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 160 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References inletOutletTotalTemperatureFvPatchScalarField::gamma_, Foam::magSqr(), Foam::pos(), inletOutletTotalTemperatureFvPatchScalarField::psiName_, inletOutletTotalTemperatureFvPatchScalarField::T0_, and inletOutletTotalTemperatureFvPatchScalarField::UName_.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 186 of file inletOutletTotalTemperatureFvPatchScalarField.C.

References token::END_STATEMENT, Foam::nl, fvPatchField::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ UName_

word UName_

private

Name of the velocity field.

Definition at line 125 of file inletOutletTotalTemperatureFvPatchScalarField.H.

Referenced by inletOutletTotalTemperatureFvPatchScalarField::updateCoeffs().

◆ psiName_

word psiName_

private

Name of the compressibility field used to calculate the wave speed.

Definition at line 128 of file inletOutletTotalTemperatureFvPatchScalarField.H.

Referenced by inletOutletTotalTemperatureFvPatchScalarField::updateCoeffs().

◆ gamma_

scalar gamma_

private

Heat capacity ratio.

Definition at line 131 of file inletOutletTotalTemperatureFvPatchScalarField.H.

Referenced by inletOutletTotalTemperatureFvPatchScalarField::updateCoeffs().

◆ T0_

scalarField T0_

private

Total pressure.

Definition at line 134 of file inletOutletTotalTemperatureFvPatchScalarField.H.

Referenced by inletOutletTotalTemperatureFvPatchScalarField::rmap(), inletOutletTotalTemperatureFvPatchScalarField::T0(), and inletOutletTotalTemperatureFvPatchScalarField::updateCoeffs().

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

src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H
src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ inletOutletTotalTemperatureFvPatchScalarField() [1/5]

◆ inletOutletTotalTemperatureFvPatchScalarField() [2/5]

◆ inletOutletTotalTemperatureFvPatchScalarField() [3/5]

◆ inletOutletTotalTemperatureFvPatchScalarField() [4/5]

◆ inletOutletTotalTemperatureFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ T0() [1/2]

◆ T0() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ UName_

◆ psiName_

◆ gamma_

◆ T0_