Public Member Functions | List of all members
outletMappedUniformInletHeatAdditionFvPatchField Class Reference
Boundary conditions » Inlet

This temperature boundary condition averages the temperature over the "outlet" patch specified by name "outletPatchName" and applies an extra heat source. This is set as a uniform temperature value on this patch. Additionally TMin/TMax limits can be applied. More...

Inheritance diagram for outletMappedUniformInletHeatAdditionFvPatchField:
[legend]
Collaboration diagram for outletMappedUniformInletHeatAdditionFvPatchField:
[legend]

Public Member Functions

 TypeName ("outletMappedUniformInletHeatAddition")
 Runtime type information. More...
 
 outletMappedUniformInletHeatAdditionFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 outletMappedUniformInletHeatAdditionFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 outletMappedUniformInletHeatAdditionFvPatchField (const outletMappedUniformInletHeatAdditionFvPatchField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping onto a new patch. More...
 
 outletMappedUniformInletHeatAdditionFvPatchField (const outletMappedUniformInletHeatAdditionFvPatchField &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< scalar > > clone () const
 Construct and return a clone. More...
 
 outletMappedUniformInletHeatAdditionFvPatchField (const outletMappedUniformInletHeatAdditionFvPatchField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy 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...
 
const word & outletPatchName () const
 Name of the outlet patch to be mapped. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This temperature boundary condition averages the temperature over the "outlet" patch specified by name "outletPatchName" and applies an extra heat source. This is set as a uniform temperature value on this patch. Additionally TMin/TMax limits can be applied.


Patch usage

Property Description Required Default value
outletPatch name of outlet patch yes
Q Heat addition yes
phi flux field name no phi
TMin min temperature limit no 0.0
TMax max temperature limit no 5000.0

Example of the boundary condition specification: 

    myPatch
    {
        type            outletMappedUniformInletHeatAddition;
        outletPatch     aPatch;
        Q               10;     // Heat addition in W
        phi             phi;
        value           uniform 0;
    }
See also
Foam::fixedValueFvPatchField
Source files

Definition at line 113 of file outletMappedUniformInletHeatAdditionFvPatchField.H.

Constructor & Destructor Documentation

◆ outletMappedUniformInletHeatAdditionFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 38 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

Referenced by outletMappedUniformInletHeatAdditionFvPatchField::clone().

Here is the caller graph for this function:

◆ outletMappedUniformInletHeatAdditionFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 72 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

◆ outletMappedUniformInletHeatAdditionFvPatchField() [3/5]

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

Construct by mapping onto a new patch.

Definition at line 54 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

◆ outletMappedUniformInletHeatAdditionFvPatchField() [4/5]

outletMappedUniformInletHeatAdditionFvPatchField ( const outletMappedUniformInletHeatAdditionFvPatchField &  ptf)

Construct as copy.

Definition at line 90 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

◆ outletMappedUniformInletHeatAdditionFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 106 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "outletMappedUniformInletHeatAddition"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Definition at line 174 of file outletMappedUniformInletHeatAdditionFvPatchField.H.

References outletMappedUniformInletHeatAdditionFvPatchField::outletMappedUniformInletHeatAdditionFvPatchField().

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 191 of file outletMappedUniformInletHeatAdditionFvPatchField.H.

References outletMappedUniformInletHeatAdditionFvPatchField::outletMappedUniformInletHeatAdditionFvPatchField().

Here is the call graph for this function:

◆ outletPatchName()

const word& outletPatchName ( ) const
inline

Name of the outlet patch to be mapped.

Definition at line 207 of file outletMappedUniformInletHeatAdditionFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 123 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::boundaryMesh(), polyPatch::boundaryMesh(), dictionary::dictName(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findPatchID(), Foam::gAverage(), Foam::gSum(), fvPatch::magSf(), Foam::max(), Foam::min(), Foam::operator==(), Foam::foamVersion::patch, fvPatch::patch(), and phi.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 189 of file outletMappedUniformInletHeatAdditionFvPatchField.C.

References fvPatchField< scalar >::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

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