Public Member Functions | List of all members
constantHeatTransfer Class Reference

Constant heat transfer model. htcConst [W/m2/K] and area/volume [1/m] must be provided. More...

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

Public Member Functions

 TypeName ("constantHeatTransfer")
 Runtime type information. More...
 
 constantHeatTransfer (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from dictionary. More...
 
virtual ~constantHeatTransfer ()
 Destructor. More...
 
virtual void calculateHtc ()
 Calculate the heat transfer coefficient. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
- Public Member Functions inherited from interRegionHeatTransferModel
 TypeName ("interRegionHeatTransferModel")
 Runtime type information. More...
 
 interRegionHeatTransferModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from dictionary. More...
 
virtual ~interRegionHeatTransferModel ()
 Destructor. More...
 
const wordnbrRegionName () const
 Return const access to the neighbour region name. More...
 
const meshToMeshmeshInterp () const
 Return const access to the mapToMap pointer. More...
 
const volScalarFieldhtc () const
 Return the heat transfer coefficient. More...
 
const interRegionHeatTransferModelnbrModel () const
 Return const access to the neighbour model. More...
 
interRegionHeatTransferModelnbrModel ()
 Return access to the neighbour model. More...
 
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldi)
 Source term to energy equation. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 Source term to compressible energy equation. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interpolate (const interRegionHeatTransferModel &nbrModel, const Field< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interpolate (const Field< Type > &field) const
 
- Public Member Functions inherited from interRegionOption
 TypeName ("interRegionOption")
 Runtime type information. More...
 
 interRegionOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from dictionary. More...
 
virtual ~interRegionOption ()
 Destructor. More...
 
const wordnbrRegionName () const
 Return const access to the neighbour region name. More...
 
const meshToMeshmeshInterp () const
 Return const access to the mapToMap pointer. 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 fvMesh &mesh),(name, modelType, dict, mesh))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () const
 Return dictionary. More...
 
bool active () const
 Return const access to the source active flag. More...
 
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi. More...
 
Switchactive ()
 Return access to the source active flag. 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 (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void correct (volScalarField &field)
 
virtual void correct (volVectorField &field)
 
virtual void correct (volSphericalTensorField &field)
 
virtual void correct (volSymmTensorField &field)
 
virtual void correct (volTensorField &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...
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Protected Member Functions inherited from interRegionHeatTransferModel
void setNbrModel ()
 Set the neighbour interRegionHeatTransferModel. More...
 
void correct ()
 Correct to calculate the inter-region heat transfer coefficient. More...
 
template<class Type >
tmp< Field< Type > > interpolate (const interRegionHeatTransferModel &nbrModel, const Field< Type > &field) const
 Interpolate field with nbrModel specified. More...
 
template<class Type >
tmp< Field< Type > > interpolate (const Field< Type > &field) const
 Interpolate field without nbrModel specified. More...
 
template<class Type >
void interpolate (const interRegionHeatTransferModel &nbrModel, const Field< Type > &field, Field< Type > &result) const
 Interpolate field with nbrModel specified. More...
 
template<class Type >
void interpolate (const Field< Type > &field, Field< Type > &result) const
 Interpolate field without nbrModel specified. More...
 
- Protected Member Functions inherited from interRegionOption
void setMapper ()
 Set the mesh to mesh interpolation object. More...
 
- Protected Attributes inherited from interRegionHeatTransferModel
word nbrModelName_
 Name of the model in the neighbour mesh. More...
 
interRegionHeatTransferModelnbrModel_
 Pointer to neighbour interRegionHeatTransferModel. More...
 
bool firstIter_
 First iteration. More...
 
label timeIndex_
 Time index - used for updating htc. More...
 
volScalarField htc_
 Heat transfer coefficient [W/m2/k] times area/volume [1/m]. More...
 
bool semiImplicit_
 Flag to activate semi-implicit coupling. More...
 
word TName_
 Name of temperature field; default = "T". More...
 
word TNbrName_
 Name of neighbour temperature field; default = "T". More...
 
- Protected Attributes inherited from interRegionOption
bool master_
 Master or slave region. More...
 
word nbrRegionName_
 Name of the neighbour region to map. More...
 
autoPtr< meshToMeshmeshInterpPtr_
 Mesh to mesh interpolation object. 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...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
Switch active_
 Source active flag. More...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry. More...
 

Detailed Description

Constant heat transfer model. htcConst [W/m2/K] and area/volume [1/m] must be provided.

Definition at line 49 of file constantHeatTransfer.H.

Constructor & Destructor Documentation

constantHeatTransfer ( const word name,
const word modelType,
const dictionary dict,
const fvMesh mesh 
)

Construct from dictionary.

Definition at line 49 of file constantHeatTransfer.C.

References IOobject::AUTO_WRITE, and IOobject::MUST_READ.

~constantHeatTransfer ( )
virtual

Destructor.

Definition at line 101 of file constantHeatTransfer.C.

Member Function Documentation

TypeName ( "constantHeatTransfer"  )

Runtime type information.

void calculateHtc ( )
virtual

Calculate the heat transfer coefficient.

Implements interRegionHeatTransferModel.

Definition at line 107 of file constantHeatTransfer.C.

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from interRegionHeatTransferModel.

Definition at line 111 of file constantHeatTransfer.C.

References interRegionHeatTransferModel::read().

Here is the call graph for this function:


The documentation for this class was generated from the following files: