Public Member Functions | List of all members
meanInletOutletFvPatchScalarField Class Reference

This boundary condition provides an outflow condition for scalars where the patch adjacent mean is applied in the case of reverse flow. More...

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

Public Member Functions

 TypeName ("meanInletOutlet")
 Runtime type information. More...
 
 meanInletOutletFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 meanInletOutletFvPatchScalarField (const meanInletOutletFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 meanInletOutletFvPatchScalarField (const meanInletOutletFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 meanInletOutletFvPatchScalarField (const meanInletOutletFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, fvMesh > &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 an outflow condition for scalars where the patch adjacent mean is applied in the case of reverse flow.

Usage
Property Description Required Default value
phi flux field name no phi

Example of the boundary condition specification: 

    <patchName>
    {
        type            meanInletOutlet;
        phi             phi;
        value           uniform 0;
    }
See also
Foam::inletOutletFvPatchField
Source files

Definition at line 78 of file meanInletOutletFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ meanInletOutletFvPatchScalarField() [1/4]

meanInletOutletFvPatchScalarField ( const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 34 of file meanInletOutletFvPatchScalarField.C.

References UPstream::blocking, dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::evaluate(), p, and Foam::Zero.

Referenced by meanInletOutletFvPatchScalarField::clone().

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

◆ meanInletOutletFvPatchScalarField() [2/4]

meanInletOutletFvPatchScalarField ( const meanInletOutletFvPatchScalarField &  ptf,
const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

meanInletOutletFvPatchScalarField onto a new patch

Definition at line 63 of file meanInletOutletFvPatchScalarField.C.

◆ meanInletOutletFvPatchScalarField() [3/4]

meanInletOutletFvPatchScalarField ( const meanInletOutletFvPatchScalarField &  )
delete

Disallow copy without setting internal field reference.

◆ meanInletOutletFvPatchScalarField() [4/4]

meanInletOutletFvPatchScalarField ( const meanInletOutletFvPatchScalarField &  tppsf,
const DimensionedField< scalar, fvMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 75 of file meanInletOutletFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "meanInletOutlet"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 123 of file meanInletOutletFvPatchScalarField.H.

References meanInletOutletFvPatchScalarField::meanInletOutletFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 87 of file meanInletOutletFvPatchScalarField.C.

References Foam::gSum(), Foam::max(), and Foam::min().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 114 of file meanInletOutletFvPatchScalarField.C.

References fvPatchField< Type >::write(), and Foam::writeEntry().

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