Public Member Functions | List of all members
fanPressureJumpFvPatchScalarField Class Reference

This boundary condition provides a fan pressure jump condition, using the cyclic condition as a base. The jump is specified as a Function1, which returns the pressure jump as a function of the total volumetric flow rate through the patch. More...

Inheritance diagram for fanPressureJumpFvPatchScalarField:
Inheritance graph
[legend]
Collaboration diagram for fanPressureJumpFvPatchScalarField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fanPressureJump")
 Runtime type information. More...
 
 fanPressureJumpFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 fanPressureJumpFvPatchScalarField (const fanPressureJumpFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given patch onto a new patch. More...
 
 fanPressureJumpFvPatchScalarField (const fanPressureJumpFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 fanPressureJumpFvPatchScalarField (const fanPressureJumpFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchField< scalar > > 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...
 

Detailed Description

This boundary condition provides a fan pressure jump condition, using the cyclic condition as a base. The jump is specified as a Function1, which returns the pressure jump as a function of the total volumetric flow rate through the patch.

A backwards-compatibility option is also provided to specify the pressure jump as a function of local velocity. In this mode the boundary condition serves as a direct replacement for the old fanFvPatchField.

Usage
Property Description Required Default value
patchType underlying patch type (should be cyclic) yes
fanCurve fan curve function yes
jumpTable jump table function (backward compatibility mode) no
reverse reverse jump direction no false
phi flux field name no phi
rho density field name no rho

Example of the boundary condition specification: 

    <patchName>
    {
        type            fanPressureJump;
        patchType       cyclic;
        fanCurve        table;
        fanCurveCoeffs
        {
            file            "$FOAM_CASE/constant/pressureVsQ";
            format          csv;
            nHeaderLine     1;
            columns         (0 1);
            separator       ",";
            mergeSeparators no;
            outOfBounds     clamp;
            interpolationScheme linear;
        }
        value           uniform 0;
    }
See also
Foam::Function1s
Source files

Definition at line 127 of file fanPressureJumpFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ fanPressureJumpFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 33 of file fanPressureJumpFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, Foam::dimVolumetricFlux, and Function1< Type >::New().

Referenced by fanPressureJumpFvPatchScalarField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fanPressureJumpFvPatchScalarField() [2/4]

fanPressureJumpFvPatchScalarField ( const fanPressureJumpFvPatchScalarField &  ptf,
const fvPatch &  p,
const DimensionedField< scalar, volMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given patch onto a new patch.

Definition at line 87 of file fanPressureJumpFvPatchScalarField.C.

◆ fanPressureJumpFvPatchScalarField() [3/4]

fanPressureJumpFvPatchScalarField ( const fanPressureJumpFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ fanPressureJumpFvPatchScalarField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 104 of file fanPressureJumpFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fanPressureJump"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 189 of file fanPressureJumpFvPatchScalarField.H.

References fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 121 of file fanPressureJumpFvPatchScalarField.C.

References Foam::dimMassFlux, Foam::dimVolumetricFlux, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), fvsPatchField< Type >::internalField(), Foam::max(), Foam::nl, and Foam::sign().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 205 of file fanPressureJumpFvPatchScalarField.C.

References Foam::vtkWriteOps::write(), and Foam::writeEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: