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

#include <fanPressureFvPatchScalarField.H>

Inheritance diagram for fanPressureFvPatchScalarField:

[legend]

Collaboration diagram for fanPressureFvPatchScalarField:

[legend]

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

Public Member Functions
	TypeName ("fanPressure")
	Runtime type information.
	fanPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	fanPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	fanPressureFvPatchScalarField (const fanPressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	fanPressureFvPatchScalarField (const fanPressureFvPatchScalarField &)
	Construct as copy.
	fanPressureFvPatchScalarField (const fanPressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &os) const
	Write.
Public Member Functions inherited from totalPressureFvPatchScalarField
	TypeName ("totalPressure")
	Runtime type information.
	totalPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	totalPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	totalPressureFvPatchScalarField (const totalPressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given totalPressureFvPatchScalarField.
	totalPressureFvPatchScalarField (const totalPressureFvPatchScalarField &)
	Construct as copy.
	totalPressureFvPatchScalarField (const totalPressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
const word &	UName () const
	Return the name of the velocity field.
word &	UName ()
	Return reference to the name of the velocity field.
const word &	phiName () const
	Return the name of the flux field.
word &	phiName ()
	Return reference to the name of the flux field.
const word &	rhoName () const
	Return the name of the density field.
word &	rhoName ()
	Return reference to the name of the density field.
const word &	psiName () const
	Return the name of the compressibility field.
word &	psiName ()
	Return reference to the name of the compressibility field.
scalar	gamma () const
	Return the heat capacity ratio.
scalar &	gamma ()
	Return reference to the heat capacity ratio to allow adjustment.
const scalarField &	p0 () const
	Return the total pressure.
scalarField &	p0 ()
	Return reference to the total pressure to allow adjustment.
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField.
virtual void	updateCoeffs (const scalarField &p0p, const vectorField &Up)
	Update the coefficients associated with the patch field.

Static Public Attributes
static const Enum< fanFlowDirection >	fanFlowDirectionNames_
	Fan flow direction names.

Detailed Description

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

The switch nonDimensional can be used for a non-dimensional fan curve. It needs inputs rpm and dm of the fan.

The nonDimensional flux is calculate as :

phi = 4.0*mDot/(rho*sqr(PI)*dm^3*omega) where: dm is the mean diameter. omega is rad/sec.

The nonDimensinal pressure :

Psi = 2 deltaP/(rho*(sqr(PI*omega*dm))) where: deltaP is the pressure drop

The non-dimensional table should be given as Psi = F(phi).

Usage

Property	Description	Required	Default
`fanCurve`	Pressure vs flow-rate	yes
`direction`	direction of flow through fan [in/out]	yes
`p0`	environmental total pressure	yes
`nonDimensional`	uses non-dimensional table	no	false
`rpm`	fan rpm for non-dimensional table	no
`dm`	mean diameter for non-dimensional table	no
`file`	fan curve file name	legacy
`outOfBounds`	out of bounds handling	legacy

Example of the boundary condition specification:

    inlet
    {
        type            fanPressure;
        direction       in;
        fanCurve
        {
            type table;
            file "<constant>/fanCurve";
            outOfBounds clamp;  // Optional out-of-bounds handling
        }
        p0              uniform 0;
        value           uniform 0;
    }

    // Legacy specification
    outlet
    {
        type            fanPressure;
        direction       out;
        file            "<constant>/fanCurve";
        outOfBounds     clamp;
        p0              uniform 0;
        value           uniform 0;
    }

Note: For compatibility with older versions (OpenFOAM-v2006 and earlier), a missing fanCurve keyword is treated as a tableFile and makes the file keyword mandatory.

See also: Foam::fanFvPatchField Foam::totalPressureFvPatchScalarField Foam::Function1

Source files

Definition at line 166 of file fanPressureFvPatchScalarField.H.

Member Enumeration Documentation

◆ fanFlowDirection

enum fanFlowDirection : uint8_t

Fan flow direction.

Enumerator
ffdIn
ffdOut

Definition at line 175 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 43 of file fanPressureFvPatchScalarField.C.

References ffdOut, p, and totalPressureFvPatchScalarField::totalPressureFvPatchScalarField().

Referenced by fanPressureFvPatchScalarField(), fanPressureFvPatchScalarField(), fanPressureFvPatchScalarField(), and TypeName().

Here is the call graph for this function:

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 75 of file fanPressureFvPatchScalarField.C.

References dict, fanFlowDirectionNames_, if(), p, and totalPressureFvPatchScalarField::totalPressureFvPatchScalarField().

Here is the call graph for this function:

◆ fanPressureFvPatchScalarField() [3/5]

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

Construct by mapping given.

fanPressureFvPatchScalarField onto a new patch

Definition at line 58 of file fanPressureFvPatchScalarField.C.

References clone(), fanPressureFvPatchScalarField(), p, Foam::rhs(), and totalPressureFvPatchScalarField::totalPressureFvPatchScalarField().

Here is the call graph for this function:

◆ fanPressureFvPatchScalarField() [4/5]

fanPressureFvPatchScalarField ( const fanPressureFvPatchScalarField & rhs )

Construct as copy.

Definition at line 110 of file fanPressureFvPatchScalarField.C.

References clone(), fanPressureFvPatchScalarField(), Foam::rhs(), and totalPressureFvPatchScalarField::totalPressureFvPatchScalarField().

Here is the call graph for this function:

◆ fanPressureFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 124 of file fanPressureFvPatchScalarField.C.

References clone(), fanPressureFvPatchScalarField(), Foam::rhs(), and totalPressureFvPatchScalarField::totalPressureFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "fanPressure" )

Runtime type information.

References fanPressureFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 280 of file fanPressureFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Referenced by fanPressureFvPatchScalarField(), fanPressureFvPatchScalarField(), and fanPressureFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 288 of file fanPressureFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from totalPressureFvPatchScalarField.

Definition at line 141 of file fanPressureFvPatchScalarField.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::max(), Foam::nl, p0, totalPressureFvPatchScalarField::phiName(), Foam::constant::mathematical::pi(), Foam::pow3(), Foam::pow4(), totalPressureFvPatchScalarField::rhoName(), Foam::sqr(), Foam::stabilise(), 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 216 of file fanPressureFvPatchScalarField.C.

References fanFlowDirectionNames_, os(), and totalPressureFvPatchScalarField::write().

Here is the call graph for this function:

Member Data Documentation

◆ fanFlowDirectionNames_

const Foam::Enum< Foam::fanPressureFvPatchScalarField::fanFlowDirection > fanFlowDirectionNames_

static

Fan flow direction names.

Definition at line 184 of file fanPressureFvPatchScalarField.H.

Referenced by fanPressureFvPatchScalarField(), and write().

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

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()

Member Data Documentation

◆ fanFlowDirectionNames_