Public Member Functions | List of all members
fanPressureJumpFvPatchScalarField Class Reference

This boundary condition provides a pressure jump condition, using the cyclic condition as a base. 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 > &)
 Construct from patch and internal field. 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 fvPatchFieldMapper &)
 Construct by mapping given patch onto a new patch. More...
 
 fanPressureJumpFvPatchScalarField (const fanPressureJumpFvPatchScalarField &)
 Copy constructor. More...
 
virtual tmp< fvPatchScalarField > clone () const
 Construct and return a clone. 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 pressure jump condition, using the cyclic condition as a base.

The jump is specified as a Function1 type, to enable the use of, e.g. constant, polynomial, table values. This boundary condition can operate in two modes - standard and backward compatibility. In standard mode, jump is specified as a function of total volumetric flow rate through the patch. In backward compatibility mode, the boundary conditions serves as a direct replacement for the fanFvPatchField, where jump is defined as a function of local velocity.

Usage
Property Description Required Default value
patchType underlying patch type should be cyclic yes
fanCurve fan curve, e.g. csvFile yes
jumpTable jump data (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            fan;
        patchType       cyclic;
        fanCurve       csvFile;
        csvFileCoeffs
        {
            hasHeaderLine   1;
            refColumn       0;
            componentColumns 1(1);
            separator       ",";
            file           "$FOAM_CASE/constant/pressureVsQ";
        }
        value           uniform 0;
    }

The above example shows the use of a comma separated (CSV) file to specify the jump condition.

Note
The underlying patchType should be set to cyclic
See also
Foam::Function1Types
Source files

Definition at line 132 of file fanPressureJumpFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ fanPressureJumpFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 84 of file fanPressureJumpFvPatchScalarField.C.

Referenced by fanPressureJumpFvPatchScalarField::clone(), and fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField().

Here is the caller graph for this function:

◆ fanPressureJumpFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

backward compatibility model

Definition at line 99 of file fanPressureJumpFvPatchScalarField.C.

References UPstream::blocking, fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField(), dictionary::found(), Function1< Type >::New(), fvPatchField< Type >::operator, and fvPatch::size().

Here is the call graph for this function:

◆ fanPressureJumpFvPatchScalarField() [3/5]

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

Construct by mapping given patch onto a new patch.

Definition at line 140 of file fanPressureJumpFvPatchScalarField.C.

References fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField().

Here is the call graph for this function:

◆ fanPressureJumpFvPatchScalarField() [4/5]

fanPressureJumpFvPatchScalarField ( const fanPressureJumpFvPatchScalarField &  ptf)

Copy constructor.

Definition at line 157 of file fanPressureJumpFvPatchScalarField.C.

References fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField().

Here is the call graph for this function:

◆ fanPressureJumpFvPatchScalarField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 171 of file fanPressureJumpFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fanPressureJump"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 200 of file fanPressureJumpFvPatchScalarField.H.

References fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Definition at line 217 of file fanPressureJumpFvPatchScalarField.H.

References fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField(), fanPressureJumpFvPatchScalarField::updateCoeffs(), and fanPressureJumpFvPatchScalarField::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 187 of file fanPressureJumpFvPatchScalarField.C.

Referenced by fanPressureJumpFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 203 of file fanPressureJumpFvPatchScalarField.C.

References Foam::makePatchTypeField(), Foam::blockMeshTools::write(), and Foam::writeEntry().

Referenced by fanPressureJumpFvPatchScalarField::clone().

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