contactAngleForce.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) 2020 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::areaSurfaceFilmModels::contactAngleForce
 
Description
    Base-class for film contact angle force models.
 
    The effect of the contact angle force can be ignored over a specified
    distance from patches.
 
SourceFiles
    contactAngleForce.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef contactAngleForce_H
#define contactAngleForce_H
 
#include "force.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace regionModels
{
namespace areaSurfaceFilmModels
{
 
/*---------------------------------------------------------------------------*\
                      Class contactAngleForce Declaration
\*---------------------------------------------------------------------------*/
 
class contactAngleForce
:
    public force
{
    // Private Data
 
        //- Coefficient applied to the contact angle force
        scalar Ccf_;
 
        //- Mask over which force is applied
        areaScalarField mask_;
 
 
    // Private Member Functions
 
        //- Initialise
        void initialise();
 
        //- No copy construct
        contactAngleForce(const contactAngleForce&) = delete;
 
        //- No copy assignment
        void operator=(const contactAngleForce&) = delete;
 
 
protected:
 
        //- Return the contact angle field
        virtual tmp<areaScalarField> theta() const = 0;
 
 
public:
 
    //- Runtime type information
    TypeName("contactAngle");
 
 
    // Constructors
 
        //- Construct from surface film model
        contactAngleForce
        (
            const word& typeName,
            liquidFilmBase& film,
            const dictionary& dict
        );
 
 
    //- Destructor
    virtual ~contactAngleForce();
 
 
    // Member Functions
 
        //- Correct
        virtual tmp<faVectorMatrix> correct(areaVectorField& U);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace areaSurfaceFilmModels
} // End namespace regionModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //