mixedEnergyCalculatedTemperatureFvPatchScalarField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2019-2023 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::mixedEnergyCalculatedTemperatureFvPatchScalarField
 
Description
    Base class for temperature boundary conditions in which the parameters of
    the mixed energy condition can be set directly.
 
SourceFiles
    mixedEnergyCalculatedTemperatureFvPatchScalarField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef mixedEnergyCalculatedTemperatureFvPatchScalarField_H
#define mixedEnergyCalculatedTemperatureFvPatchScalarField_H
 
#include "calculatedFvPatchFields.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
     Class mixedEnergyCalculatedTemperatureFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
 
class mixedEnergyCalculatedTemperatureFvPatchScalarField
:
    public calculatedFvPatchScalarField
{
    // Private Data
 
        //- Energy value field
        scalarField heRefValue_;
 
        //- Energy normal gradient field
        scalarField heRefGrad_;
 
        //- Fraction (0-1) of energy value used for boundary condition
        scalarField heValueFraction_;
 
 
public:
 
    // Static Data Members
 
        //- Run-time type information
        TypeName("mixedEnergyCalculatedTemperature");
 
 
    // Constructors
 
        //- Construct from patch and internal field
        mixedEnergyCalculatedTemperatureFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&
        );
 
        //- Construct from patch, internal field and dictionary
        mixedEnergyCalculatedTemperatureFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given
        //  mixedEnergyCalculatedTemperatureFvPatchScalarField
        //  onto a new patch
        mixedEnergyCalculatedTemperatureFvPatchScalarField
        (
            const mixedEnergyCalculatedTemperatureFvPatchScalarField&,
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Disallow copy without setting internal field reference
        mixedEnergyCalculatedTemperatureFvPatchScalarField
        (
            const mixedEnergyCalculatedTemperatureFvPatchScalarField&
        ) = delete;
 
        //- Copy constructor setting internal field reference
        mixedEnergyCalculatedTemperatureFvPatchScalarField
        (
            const mixedEnergyCalculatedTemperatureFvPatchScalarField&,
            const DimensionedField<scalar, volMesh>&
        );
 
        //- Construct and return a clone setting internal field reference
        virtual tmp<fvPatchScalarField> clone
        (
            const DimensionedField<scalar, volMesh>& iF
        ) const
        {
            return tmp<fvPatchScalarField>
            (
                new mixedEnergyCalculatedTemperatureFvPatchScalarField
                (
                    *this,
                    iF
                )
            );
        }
 
 
    // Member Functions
 
        // Access
 
            //- Return true if this patch field fixes a value
            virtual bool fixesValue() const
            {
                return false;
            }
 
            //- Access the energy value
            inline scalarField& heRefValue()
            {
                return heRefValue_;
            }
 
            //- Access the energy value
            inline const scalarField& heRefValue() const
            {
                return heRefValue_;
            }
 
            //- Access the energy gradient
            inline scalarField& heRefGrad()
            {
                return heRefGrad_;
            }
 
            //- Access the energy gradient
            inline const scalarField& heRefGrad() const
            {
                return heRefGrad_;
            }
 
            //- Access the energy fraction
            inline scalarField& heValueFraction()
            {
                return heValueFraction_;
            }
 
            //- Access the energy fraction
            inline const scalarField& heValueFraction() const
            {
                return heValueFraction_;
            }
 
 
        // Mapping functions
 
            //- Map the given fvPatchField onto this fvPatchField
            virtual void map
            (
                const fvPatchScalarField&,
                const fvPatchFieldMapper&
            );
 
            //- Reset the fvPatchField to the given fvPatchField
            //  Used for mesh to mesh mapping
            virtual void reset(const fvPatchScalarField&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //