contactHeatFluxSource Class Reference

Applies contact heat flux between specified faMesh and fvMesh within a specified region for compressible flows. More...

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

Public Member Functions

 TypeName ("contactHeatFluxSource")
 Runtime type information. More...
 
 contactHeatFluxSource (const word &sourceName, const word &modelType, const dictionary &dict, const fvPatch &patch)
 Construct from explicit source name and mesh. More...
 
 contactHeatFluxSource (const contactHeatFluxSource &)=delete
 No copy construct. More...
 
void operator= (const contactHeatFluxSource &)=delete
 No copy assignment. More...
 
virtual ~contactHeatFluxSource ()=default
 Destructor. More...
 
virtual void autoMap (const fvPatchFieldMapper &mapper)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< scalar > &fld, const labelList &map)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< scalar > &eqn, const label fieldi)
 Add explicit contribution to compressible momentum equation. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
- Public Member Functions inherited from faceSetOption
 TypeName ("faceSetOption")
 Runtime type information. More...
 
 faceSetOption (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
 Construct from components. More...
 
virtual ~faceSetOption ()=default
 Destructor. More...
 
scalar timeStart () const noexcept
 Return const access to the time start. More...
 
scalar duration () const noexcept
 Return const access to the duration. More...
 
bool inTimeLimits (const scalar timeValue) const
 Return true if within time limits. More...
 
selectionModeType selectionMode () const noexcept
 Return const access to the face selection mode. More...
 
bool useSubMesh () const noexcept
 True if sub-selection should be used. More...
 
const wordRezoneName () const noexcept
 
scalar A () const noexcept
 Return const access to the total face area. More...
 
const labelListfaces () const noexcept
 Return const access to the face selection. More...
 
scalar timeStart (scalar val) noexcept
 Adjust the time start, return the old value. More...
 
scalar duration (scalar val) noexcept
 Adjust the duration, return the old value. More...
 
virtual bool isActive ()
 Is the source active? More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
- Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch),(name, modelType, dict, patch))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvPatch &patch)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()=default
 Destructor. More...
 
const wordname () const noexcept
 Return const access to the source name. More...
 
const fvMeshmesh () const noexcept
 Return const access to the mesh database. More...
 
const fvPatchpatch () const noexcept
 Return const access to fvPatch. More...
 
const dictionarycoeffs () const noexcept
 Return dictionary. More...
 
bool active () const noexcept
 True if source is active. More...
 
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi. More...
 
const wordregionName () const noexcept
 The region name. More...
 
const faMeshregionMesh () const
 Return the region mesh database (demand-driven) More...
 
const volSurfaceMappingvsm () const
 Return volSurfaceMapping (demand-driven) More...
 
bool active (const bool on) noexcept
 Change source active flag, return previous value. More...
 
virtual bool isActive ()
 Is the source active? More...
 
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list. More...
 
virtual void checkApplied () const
 Check that the source has been applied. More...
 
virtual void addSup (const areaScalarField &h, faMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, faMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const areaScalarField &h, const areaScalarField &rho, faMatrix< tensor > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< scalar > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< vector > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void constrain (faMatrix< tensor > &eqn, const label fieldi)
 
virtual void correct (areaScalarField &field)
 
virtual void correct (areaVectorField &field)
 
virtual void correct (areaSphericalTensorField &field)
 
virtual void correct (areaSymmTensorField &field)
 
virtual void correct (areaTensorField &field)
 
virtual void writeHeader (Ostream &) const
 Write the source header information. More...
 
virtual void writeFooter (Ostream &) const
 Write the source footer information. More...
 
virtual void writeData (Ostream &) const
 Write the source properties. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
- Public Member Functions inherited from temperatureCoupledBase
 temperatureCoupledBase (const fvPatch &patch, const word &calculationMethod, const word &kappaName, const word &alphaAniName, const word &alphaName)
 Construct from patch and K name. More...
 
 temperatureCoupledBase (const fvPatch &patch, const dictionary &dict)
 Construct from patch and dictionary. More...
 
 temperatureCoupledBase (const fvPatch &patch, const temperatureCoupledBase &base)
 Construct from patch and temperatureCoupledBase. More...
 
 temperatureCoupledBase (const temperatureCoupledBase &)
 Construct as copy. More...
 
virtual ~temperatureCoupledBase ()=default
 Destructor. More...
 
word KMethod () const
 Method to obtain K. More...
 
const wordkappaName () const
 Name of thermal conductivity field. More...
 
const wordalphaName () const
 Name of thermal diffusivity field. More...
 
virtual void autoMap (const fvPatchFieldMapper &)=0
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< scalar > &, const labelList &)=0
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual tmp< scalarFieldkappa (const scalarField &Tp) const
 Given patch temperature calculate corresponding K field. More...
 
virtual tmp< scalarFieldalpha (const scalarField &Tp) const
 Given patch temperature calculate corresponding alphaEff field. More...
 
void write (Ostream &os) const
 Write. More...
 

Additional Inherited Members

- Public Types inherited from faceSetOption
enum  selectionModeType { smAll , smVolFaceZone }
 Enumeration for selection mode types. More...
 
- Public Types inherited from temperatureCoupledBase
enum  KMethodType {
  mtFluidThermo , mtSolidThermo , mtDirectionalSolidThermo , mtLookup ,
  mtFunction
}
 Type of supplied Kappa. More...
 
- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvPatch &patch)
 Return a reference to the selected faOption model. More...
 
- Public Attributes inherited from option
bool log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from faceSetOption
static const Enum< selectionModeTypeselectionModeTypeNames_
 List of selection mode type names. More...
 
- Protected Member Functions inherited from faceSetOption
void setSelection (const dictionary &dict)
 Set face selection name from dictionary input. More...
 
void setFaceSelection ()
 Set face selection based on user input selection mode. More...
 
void setArea ()
 Recalculate the area. More...
 
- Protected Member Functions inherited from option
void resetApplied ()
 Resize/reset applied flag list for all fieldNames_ entries. More...
 
- Protected Attributes inherited from faceSetOption
scalar timeStart_
 Time start. More...
 
scalar duration_
 Duration. More...
 
selectionModeType selectionMode_
 Face selection mode. More...
 
wordRe zoneName_
 Name of zone for (volume) "faceZone" selection. More...
 
labelList faces_
 Set of faces to apply source to. More...
 
scalar A_
 Sum of face area. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 Reference to the mesh database. More...
 
const fvPatchpatch_
 Reference to the patch. More...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< boolapplied_
 Applied flag list - corresponds to each fieldNames_ entry. More...
 
word regionName_
 Region name (finite-area) More...
 
- Protected Attributes inherited from temperatureCoupledBase
const fvPatchpatch_
 Underlying patch. More...
 
const KMethodType method_
 How to get K. More...
 
const word kappaName_
 Name of thermal conductivity field (if looked up from database) More...
 
const word alphaAniName_
 Name of the non-Isotropic alpha (default: Anialpha) More...
 
const word alphaName_
 Name of thermal diffusivity. More...
 
autoPtr< PatchFunction1< scalar > > kappaFunction1_
 Function1 for kappa. More...
 
autoPtr< PatchFunction1< scalar > > alphaFunction1_
 Function1 for alpha. More...
 
- Static Protected Attributes inherited from temperatureCoupledBase
static const Enum< KMethodTypeKMethodTypeNames_
 

Detailed Description

Applies contact heat flux between specified faMesh and fvMesh within a specified region for compressible flows.

Usage
Minimal example by using constant/faOptions:
contactHeatFluxSource1
{
    // Mandatory entries (unmodifiable)
    type                contactHeatFluxSource;
    Tprimary            <TprimaryFieldName>;

    // Optional entries (runtime modifiable)
    T                   <Tname>;
    thicknessLayers     (<layer1> <layer2> ... <layerN>);

    // Conditional optional entries (runtime modifiable)

        // when the entry "thicknessLayers" is present
        kappaLayers     (<layer1> <layer2> ... <layerN>);

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
type Type name: contactHeatFluxSource word yes -
Tprimary Name of primary temperature field word yes -
T Name of operand temperature field word no T
thicknessLayers List of thicknesses of layers scalarList no -
kappaLayers List of conductivities of layers scalarList cndtnl -

The inherited entries are elaborated in:

Source files

Definition at line 134 of file contactHeatFluxSource.H.

Constructor & Destructor Documentation

◆ contactHeatFluxSource() [1/2]

contactHeatFluxSource ( const word sourceName,
const word modelType,
const dictionary dict,
const fvPatch patch 
)

Construct from explicit source name and mesh.

Definition at line 49 of file contactHeatFluxSource.C.

References dict, Foam::dimTemperature, option::fieldNames_, contactHeatFluxSource::read(), option::resetApplied(), and List< T >::resize().

Here is the call graph for this function:

◆ contactHeatFluxSource() [2/2]

No copy construct.

◆ ~contactHeatFluxSource()

virtual ~contactHeatFluxSource ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "contactHeatFluxSource"  )

Runtime type information.

◆ operator=()

void operator= ( const contactHeatFluxSource )
delete

No copy assignment.

◆ autoMap()

virtual void autoMap ( const fvPatchFieldMapper mapper)
inlinevirtual

Map (and resize as needed) from self given a mapping object.

Implements temperatureCoupledBase.

Definition at line 205 of file contactHeatFluxSource.H.

References temperatureCoupledBase::autoMap().

Here is the call graph for this function:

◆ rmap()

virtual void rmap ( const fvPatchField< scalar > &  fld,
const labelList map 
)
inlinevirtual

Reverse map the given fvPatchField onto this fvPatchField.

Implements temperatureCoupledBase.

Definition at line 214 of file contactHeatFluxSource.H.

References fld(), and temperatureCoupledBase::rmap().

Here is the call graph for this function:

◆ addSup()

void addSup ( const areaScalarField h,
const areaScalarField rho,
faMatrix< scalar > &  eqn,
const label  fieldi 
)
virtual

Add explicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 146 of file contactHeatFluxSource.C.

References DebugInfo, Foam::endl(), mesh, Foam::name(), faMatrix< Type >::psi(), Foam::fam::Sp(), timeIndex, and vsm().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read source dictionary.

Reimplemented from faceSetOption.

Definition at line 176 of file contactHeatFluxSource.C.

References dict, forAll, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Referenced by contactHeatFluxSource::contactHeatFluxSource().

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: