thermalShellModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2019-2025 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::regionModels::thermalShellModel
 
Description
    Intermediate class for thermal-shell finite-area models.
 
Usage
    Example of the boundary condition specification:
    \verbatim
    <patchName>
    {
        // Optional entries
        thermalShellModel     <word>;
 
        Ts                    <word>;
        Tprimary              <word>;
 
        // Inherited entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
      Property  | Description                       | Type  | Reqd | Deflt
      Ts        | Name of shell temperature field   | word  | no   | Ts(suffix)
      Tprimary  | Name of primary temperature field | word  | no   | T
      thermalShellModel | Name of thermalShellModel thermal-shell model <!--
                        -->                      | word | choice | -
    \endtable
 
    Fields/variables used:
    \table
      Property  | Description               | Type   | Deflt
      Ts        | Temperature               | shell  | Ts(suffix)
      Tprimary  | Temperature               | volume | T
    \endtable
 
    \b Naming changes (possibly breaking) from 2506 and earlier:
    \table
      Keyword  | Description               | Keyword (old) | Deflt (old)
      Ts       | Temperature (shell)       | -   | "Ts_" + regionName
      Tprimary | Temperature (volume)      | T   | -
    \endtable
    If \c Tprimary is missing, will still accept the generic "T",
    but is silently deprecated (may change in the future).
 
    The inherited entries are elaborated in:
      - \link regionFaModel.H \endlink
 
SourceFiles
    thermalShellModel.C
    thermalShellModelNew.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_regionModels_thermalShellModel_H
#define Foam_regionModels_thermalShellModel_H
 
#include "areaFieldsFwd.H"
#include "volFieldsFwd.H"
#include "regionFaModel.H"
#include "faOptions.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace regionModels
{
 
/*---------------------------------------------------------------------------*\
                      Class thermalShellModel Declaration
\*---------------------------------------------------------------------------*/
 
class thermalShellModel
:
    public regionFaModel
{
protected:
 
    // Protected Data
 
        //- Name of shell temperature field (default: "Ts"+suffix)
        const word TName_;
 
        //- Name of volume temperature field (default: "T")
        const word TprimaryName_;
 
        //- Primary (volume) region temperature
        const volScalarField& Tp_;
 
        //- Shell temperature
        areaScalarField T_;
 
        //- Reference to faOptions
        Foam::fa::options& faOptions_;
 
 
public:
 
    //- Runtime type information
    TypeName("thermalShellModel");
 
 
    // Declare runtime constructor selection tables
 
         declareRunTimeSelectionTable
         (
             autoPtr,
             thermalShellModel,
             dictionary,
             (
                const word& modelType,
                const fvMesh& mesh,
                const dictionary& dict
             ),
             (modelType, mesh, dict)
         );
 
 
    // Constructors
 
        //- Construct from type name and mesh and dict
        thermalShellModel
        (
            const word& modelType,
            const fvMesh& mesh,
            const dictionary& dict
        );
 
        //- No copy construct
        thermalShellModel(const thermalShellModel&) = delete;
 
        //- No copy assignment
        void operator=(const thermalShellModel&) = delete;
 
 
    // Selectors
 
        //- Return a reference to the selected model using dictionary
        static autoPtr<thermalShellModel> New
        (
            const fvMesh& mesh,
            const dictionary& dict
        );
 
 
    //- Destructor
    virtual ~thermalShellModel() = default;
 
 
    // Member Functions
 
        //- Return primary (volume) region temperature
        const volScalarField& Tp() const noexcept { return Tp_; }
 
        //- Return shell temperature
        const areaScalarField& T() const noexcept { return T_; }
 
        //- Return faOptions
        Foam::fa::options& faOptions() noexcept { return faOptions_; }
 
 
    // Evolution
 
        //- Pre-evolve region
        virtual void preEvolveRegion();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace regionModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //