This boundary condition provides a time-varying form of the uniform total pressure boundary condition. More...

Inheritance diagram for uniformTotalPressureFvPatchScalarField:

Collaboration diagram for uniformTotalPressureFvPatchScalarField:

[legend]

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

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

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

	uniformTotalPressureFvPatchScalarField (const uniformTotalPressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch. More...

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

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

	uniformTotalPressureFvPatchScalarField (const uniformTotalPressureFvPatchScalarField &, 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 word &	UName () const
	Return the name of the velocity field. More...

word &	UName ()
	Return reference to the name of the velocity field. More...

scalar	gamma () const
	Return the heat capacity ratio. More...

scalar &	gamma ()
	Return reference to the heat capacity ratio to allow adjustment. More...

virtual void	updateCoeffs (const vectorField &Up)
	Update the coefficients associated with the patch field. 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	phiName_
	Name of the flux transporting the field. More...

word	rhoName_
	Name of the density field used to normalise the mass flux. More...

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

scalar	gamma_
	Heat capacity ratio. More...

autoPtr< DataEntry< scalar > >	pressure_
	Table of time vs total pressure, including the bounding treatment. More...

Detailed Description

This boundary condition provides a time-varying form of the uniform total pressure boundary condition.

Patch usage

Property	Description	Required	Default value
`U`	velocity field name	no	U
`phi`	flux field name	no	phi
`rho`	density field name	no	none
`psi`	compressibility field name	no	none
`gamma`	ratio of specific heats (Cp/Cv)	yes
`pressure`	total pressure as a function of time	yes

Example of the boundary condition specification:

    myPatch
    {
        type            uniformTotalPressure;
        U               U;
        phi             phi;
        rho             rho;
        psi             psi;
        gamma           1.4;
        pressure        uniform 1e5;
    }

The pressure entry is specified as a DataEntry type, able to describe time varying functions.

Note: The default boundary behaviour is for subsonic, incompressible flow.

See also: Foam::DataEntry Foam::uniformFixedValueFvPatchField Foam::totalPressureFvPatchField

Source files

Definition at line 126 of file uniformTotalPressureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ uniformTotalPressureFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 36 of file uniformTotalPressureFvPatchScalarField.C.

Referenced by uniformTotalPressureFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ uniformTotalPressureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 53 of file uniformTotalPressureFvPatchScalarField.C.

References dict, Foam::operator==(), p, and scalarField().

Here is the call graph for this function:

◆ uniformTotalPressureFvPatchScalarField() [3/5]

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

Construct by mapping given patch field onto a new patch.

Definition at line 84 of file uniformTotalPressureFvPatchScalarField.C.

References Foam::operator==().

Here is the call graph for this function:

◆ uniformTotalPressureFvPatchScalarField() [4/5]

uniformTotalPressureFvPatchScalarField ( const uniformTotalPressureFvPatchScalarField & ptf )

Construct as copy.

Definition at line 110 of file uniformTotalPressureFvPatchScalarField.C.

◆ uniformTotalPressureFvPatchScalarField() [5/5]

uniformTotalPressureFvPatchScalarField	(	const uniformTotalPressureFvPatchScalarField &	ptf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 126 of file uniformTotalPressureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformTotalPressure" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 191 of file uniformTotalPressureFvPatchScalarField.H.

References uniformTotalPressureFvPatchScalarField::uniformTotalPressureFvPatchScalarField().

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 208 of file uniformTotalPressureFvPatchScalarField.H.

References uniformTotalPressureFvPatchScalarField::uniformTotalPressureFvPatchScalarField().

Here is the call graph for this function:

◆ UName() [1/2]

const word& UName ( ) const

inline

Return the name of the velocity field.

Definition at line 224 of file uniformTotalPressureFvPatchScalarField.H.

References uniformTotalPressureFvPatchScalarField::UName_.

◆ UName() [2/2]

word& UName ( )

inline

Return reference to the name of the velocity field.

to allow adjustment

Definition at line 231 of file uniformTotalPressureFvPatchScalarField.H.

◆ gamma() [1/2]

scalar gamma ( ) const

inline

Return the heat capacity ratio.

Definition at line 237 of file uniformTotalPressureFvPatchScalarField.H.

References uniformTotalPressureFvPatchScalarField::gamma_.

◆ gamma() [2/2]

scalar& gamma ( )

inline

Return reference to the heat capacity ratio to allow adjustment.

Definition at line 243 of file uniformTotalPressureFvPatchScalarField.H.

References uniformTotalPressureFvPatchScalarField::gamma_.

◆ updateCoeffs() [1/2]

void updateCoeffs ( const vectorField & Up )

virtual

Update the coefficients associated with the patch field.

using the given patch velocity field

Definition at line 144 of file uniformTotalPressureFvPatchScalarField.C.

References dimensionedInternalField(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::magSqr(), Foam::operator==(), Foam::pos(), Foam::pow(), and rho.

Here is the call graph for this function:

◆ updateCoeffs() [2/2]

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 211 of file uniformTotalPressureFvPatchScalarField.C.

References uniformTotalPressureFvPatchScalarField::UName_.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 217 of file uniformTotalPressureFvPatchScalarField.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 133 of file uniformTotalPressureFvPatchScalarField.H.

Referenced by uniformTotalPressureFvPatchScalarField::UName(), and uniformTotalPressureFvPatchScalarField::updateCoeffs().

◆ phiName_

word phiName_

private

Name of the flux transporting the field.

Definition at line 136 of file uniformTotalPressureFvPatchScalarField.H.

◆ rhoName_

word rhoName_

private

Name of the density field used to normalise the mass flux.

if neccessary

Definition at line 140 of file uniformTotalPressureFvPatchScalarField.H.

◆ psiName_

word psiName_

private

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

Definition at line 143 of file uniformTotalPressureFvPatchScalarField.H.

◆ gamma_

scalar gamma_

private

Heat capacity ratio.

Definition at line 146 of file uniformTotalPressureFvPatchScalarField.H.

Referenced by uniformTotalPressureFvPatchScalarField::gamma().

◆ pressure_

autoPtr<DataEntry<scalar> > pressure_

private

Table of time vs total pressure, including the bounding treatment.

Definition at line 149 of file uniformTotalPressureFvPatchScalarField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H
src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ uniformTotalPressureFvPatchScalarField() [1/5]

◆ uniformTotalPressureFvPatchScalarField() [2/5]

◆ uniformTotalPressureFvPatchScalarField() [3/5]

◆ uniformTotalPressureFvPatchScalarField() [4/5]

◆ uniformTotalPressureFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ UName() [1/2]

◆ UName() [2/2]

◆ gamma() [1/2]

◆ gamma() [2/2]

◆ updateCoeffs() [1/2]

◆ updateCoeffs() [2/2]

◆ write()

Field Documentation

◆ UName_

◆ phiName_

◆ rhoName_

◆ psiName_

◆ gamma_

◆ pressure_