This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan. More...

Inheritance diagram for fanPressureFvPatchScalarField:

[legend]

Collaboration diagram for fanPressureFvPatchScalarField:

[legend]

Public Types
enum	fanFlowDirection { ffdIn, ffdOut }
	Fan flow direction. More...

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

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

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

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

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

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

	fanPressureFvPatchScalarField (const fanPressureFvPatchScalarField &, 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...

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

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

Public Member Functions inherited from totalPressureFvPatchScalarField
	TypeName ("totalPressure")
	Runtime type information. More...

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

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

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

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

	totalPressureFvPatchScalarField (const totalPressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy 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...

const word &	phiName () const
	Return the name of the flux field. More...

word &	phiName ()
	Return reference to the name of the flux field. More...

const word &	rhoName () const
	Return the name of the density field. More...

word &	rhoName ()
	Return reference to the name of the density field. More...

const word &	psiName () const
	Return the name of the compressibility field. More...

word &	psiName ()
	Return reference to the name of the compressibility field. More...

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

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

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

scalarField &	p0 ()
	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 (const scalarField &p0p, const vectorField &Up)
	Update the coefficients associated with the patch field. More...

Static Public Attributes
static const NamedEnum< fanFlowDirection, 2 >	fanFlowDirectionNames_
	Fan flow directions names. More...

Private Attributes
interpolationTable< scalar >	fanCurve_
	Tabulated fan curve. More...

fanFlowDirection	direction_
	Direction of flow through the fan relative to patch. More...

Detailed Description

This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan.

Patch usage

Property	Description	Required
`fileName`	fan curve file name	yes
`outOfBounds`	out of bounds handling	yes
`direction`	direction of flow through fan [in/out]	yes
`p0`	environmental total pressure	yes

Example of the boundary condition specification:

    inlet
    {
        type            fanPressure;
        fileName        "fanCurve";
        outOfBounds     clamp;
        direction       in;
        p0              uniform 0;
        value           uniform 0;
    }

    outlet
    {
        type            fanPressure;
        fileName        "fanCurve";
        outOfBounds     clamp;
        direction       out;
        p0              uniform 0;
        value           uniform 0;
    }

See also: Foam::fanFvPatchField Foam::totalPressureFvPatchScalarField Foam::interpolationTable

Source files

Definition at line 116 of file fanPressureFvPatchScalarField.H.

Member Enumeration Documentation

◆ fanFlowDirection

enum fanFlowDirection

Fan flow direction.

Enumerator
ffdIn
ffdOut

Definition at line 124 of file fanPressureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ fanPressureFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 57 of file fanPressureFvPatchScalarField.C.

Referenced by fanPressureFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ fanPressureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 83 of file fanPressureFvPatchScalarField.C.

◆ fanPressureFvPatchScalarField() [3/5]

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

Construct by mapping given.

fanPressureFvPatchScalarField onto a new patch

Definition at line 69 of file fanPressureFvPatchScalarField.C.

◆ fanPressureFvPatchScalarField() [4/5]

fanPressureFvPatchScalarField ( const fanPressureFvPatchScalarField & pfopsf )

Construct as copy.

Definition at line 96 of file fanPressureFvPatchScalarField.C.

◆ fanPressureFvPatchScalarField() [5/5]

fanPressureFvPatchScalarField	(	const fanPressureFvPatchScalarField &	pfopsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 107 of file fanPressureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fanPressure" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 186 of file fanPressureFvPatchScalarField.H.

References fanPressureFvPatchScalarField::fanPressureFvPatchScalarField().

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.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 203 of file fanPressureFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 120 of file fanPressureFvPatchScalarField.C.

References Foam::dimArea, Foam::dimDensity, dimensionedInternalField(), Foam::dimVelocity, fanPressureFvPatchScalarField::direction_, Foam::exit(), fanPressureFvPatchScalarField::fanCurve_, Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::max(), Foam::nl, totalPressureFvPatchScalarField::p0(), phi, totalPressureFvPatchScalarField::phiName(), totalPressureFvPatchScalarField::rhoName(), totalPressureFvPatchScalarField::UName(), and totalPressureFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 170 of file fanPressureFvPatchScalarField.C.

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

Here is the call graph for this function:

Field Documentation

◆ fanFlowDirectionNames_

const Foam::NamedEnum< Foam::fanPressureFvPatchScalarField::fanFlowDirection, 2 > fanFlowDirectionNames_

static

Fan flow directions names.

Definition at line 131 of file fanPressureFvPatchScalarField.H.

◆ fanCurve_

interpolationTable<scalar> fanCurve_

private

Tabulated fan curve.

Definition at line 139 of file fanPressureFvPatchScalarField.H.

Referenced by fanPressureFvPatchScalarField::updateCoeffs().

◆ direction_

fanFlowDirection direction_

private

Direction of flow through the fan relative to patch.

Definition at line 142 of file fanPressureFvPatchScalarField.H.

Referenced by fanPressureFvPatchScalarField::updateCoeffs().

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

src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.C

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ fanFlowDirection

Constructor & Destructor Documentation

◆ fanPressureFvPatchScalarField() [1/5]

◆ fanPressureFvPatchScalarField() [2/5]

◆ fanPressureFvPatchScalarField() [3/5]

◆ fanPressureFvPatchScalarField() [4/5]

◆ fanPressureFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Field Documentation

◆ fanFlowDirectionNames_

◆ fanCurve_

◆ direction_