immersedBoundaryVelocityWallFunctionFvPatchVectorField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | foam-extend: Open Source CFD
   \\    /   O peration     | Version:     3.2
    \\  /    A nd           | Web:         http://www.foam-extend.org
     \\/     M anipulation  | For copyright notice see file Copyright
-------------------------------------------------------------------------------
License
    This file is part of foam-extend.
 
    foam-extend 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.
 
    foam-extend 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 foam-extend.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::incompressible::RASModels::
    immersedBoundaryVelocityWallFunctionFvPatchVectorField
 
Description
    Boundary condition for velocity when using wall functions
    - uses tangential velocity as prescribed by the epsilon boundary condition
      to enforce into the fit
 
SourceFiles
    immersedBoundaryVelocityWallFunctionFvPatchVectorField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef immersedBoundaryVelocityWallFunctionFvPatchVectorField_H
#define immersedBoundaryVelocityWallFunctionFvPatchVectorField_H
 
#include "fvPatchFields.H"
#include "immersedBoundaryFvPatchFields.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace incompressible
{
namespace RASModels
{
 
/*---------------------------------------------------------------------------*\
    Class immersedBoundaryVelocityWallFunctionFvPatchVectorField Declaration
\*---------------------------------------------------------------------------*/
 
class immersedBoundaryVelocityWallFunctionFvPatchVectorField
:
    public immersedBoundaryFvPatchVectorField
{
    // Private data
 
        //- Tangential velocity value to fix in IB cell
        mutable scalarField wallTangentialValue_;
 
        //- Wall shear stress
        mutable vectorField tauWall_;
 
        //- Indicator on values to fix
        mutable boolList wallMask_;
 
 
protected:
 
    // Protected Member Functions
 
        //- Set IB cell values: contains data manipulation
        virtual void setIbCellValues(const vectorField&) const;
 
 
public:
 
    //- Runtime type information
    TypeName("immersedBoundaryVelocityWallFunction");
 
 
    // Constructors
 
        //- Construct from patch and internal field
        immersedBoundaryVelocityWallFunctionFvPatchVectorField
        (
            const fvPatch&,
            const DimensionedField<vector, volMesh>&
        );
 
        //- Construct from patch, internal field and dictionary
        immersedBoundaryVelocityWallFunctionFvPatchVectorField
        (
            const fvPatch&,
            const DimensionedField<vector, volMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given
        //  immersedBoundaryVelocityWallFunctionFvPatchVectorField
        //  onto a new patch
        immersedBoundaryVelocityWallFunctionFvPatchVectorField
        (
            const immersedBoundaryVelocityWallFunctionFvPatchVectorField&,
            const fvPatch&,
            const DimensionedField<vector, volMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Construct as copy
        immersedBoundaryVelocityWallFunctionFvPatchVectorField
        (
            const immersedBoundaryVelocityWallFunctionFvPatchVectorField&
        );
 
        //- Construct and return a clone
        virtual tmp<fvPatchVectorField> clone() const
        {
            return tmp<fvPatchVectorField>
            (
                new immersedBoundaryVelocityWallFunctionFvPatchVectorField
                (
                    *this
                )
            );
        }
 
        //- Construct as copy setting internal field reference
        immersedBoundaryVelocityWallFunctionFvPatchVectorField
        (
            const immersedBoundaryVelocityWallFunctionFvPatchVectorField&,
            const DimensionedField<vector, volMesh>&
        );
 
        //- Construct and return a clone setting internal field reference
        virtual tmp<fvPatchVectorField> clone
        (
            const DimensionedField<vector, volMesh>& iF
        ) const
        {
            return tmp<fvPatchVectorField>
            (
                new immersedBoundaryVelocityWallFunctionFvPatchVectorField
                (
                    *this,
                    iF
                )
            );
        }
 
 
    //- Destructor
    virtual ~immersedBoundaryVelocityWallFunctionFvPatchVectorField()
    {}
 
 
    // Member functions
 
        // Access
 
            //- Access to tangential velocity value to fix in IB cell
            //  Note non-const access
            scalarField& wallTangentialValue() const;
 
            //- Return wall shear stress
            const vectorField& wallShearStress() const;
 
            //- Access to wall shear stress in IB cell
            //  Note non-const access
            vectorField& tauWall() const;
 
            //- Access to indicator on fixed values.  Note non-const access
            boolList& wallMask() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace RASModels
} // End namespace incompressible
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //