temperatureDependentSurfaceTension.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) 2017 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::surfaceTensionModels::temperatureDependent
 
Description
    Temperature-dependent surface tension model.
 
    The surface tension is evaluated from the specified Foam::Function1 for the
    temperature field looked-up from the mesh database the name of which
    may optionally be provided.
 
Usage
    \table
        Property     | Description               | Required    | Default value
        T            | Temperature field name    | no          | T
        sigma        | Surface tension function  | yes         |
    \endtable
 
    Example of the surface tension specification:
    \verbatim
        sigma
        {
            type                temperatureDependent;
            sigma               constant 0.07;
        }
    \endverbatim
 
See also
    Foam::surfaceTensionModel
    Foam::Function1
 
SourceFiles
    temperatureDependentSurfaceTension.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef temperatureDependentSurfaceTension_H
#define temperatureDependentSurfaceTension_H
 
#include "surfaceTensionModel.H"
#include "Function1.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
namespace surfaceTensionModels
{
 
/*---------------------------------------------------------------------------*\
                           Class temperatureDependent Declaration
\*---------------------------------------------------------------------------*/
 
class temperatureDependent
:
    public surfaceTensionModel
{
    // Private data
 
        //- Name of temperature field, default = "T"
        word TName_;
 
        //- Surface-tension function
        autoPtr<Function1<scalar>> sigma_;
 
 
public:
 
    //- Runtime type information
    TypeName("temperatureDependent");
 
 
    // Constructors
 
        //- Construct from dictionary and mesh
        temperatureDependent
        (
            const dictionary& dict,
            const fvMesh& mesh
        );
 
 
    //- Destructor
    virtual ~temperatureDependent();
 
 
    // Member Functions
 
        //- Surface tension coefficient
        virtual tmp<volScalarField> sigma() const;
 
        //- Update surface tension coefficient from given dictionary
        virtual bool readDict(const dictionary& dict);
 
        //- Write in dictionary format
        virtual bool writeData(Ostream& os) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace surfaceTensionModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //