immersedBoundaryWallFunctionFvPatchField.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::immersedBoundaryWallFunctionFvPatchField
 
Description
    Boundary condition for passive turbulence variables (U, k, q, R, nut)
    when using wall functions on an immersed boundary patch
 
    Apart form standard immersed boundary capability, the patch field allows
    only some values to be fixed, as defined by the wall function calculation.
 
    This is handled using the ibWallValue and ibWallMask arrays, corresponding
    to the number of ibCells
 
    The implementation of wall functions on an immersed boundary will fix
    the values of k, epsilon, nut and tangential velocity in cells within
    the log-law layer.  For the cells in the laminar sublayer, k and epsilon
    (omega) will be calculated using a zero gradient condition,
    nut will be set to zero and the tangential component of the
    velocity will be corrected.
 
Author
    Hrvoje Jasak, Wikki Ltd.  All rights reserved
 
SourceFiles
    immersedBoundaryWallFunctionFvPatchField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef immersedBoundaryWallFunctionFvPatchField_H
#define immersedBoundaryWallFunctionFvPatchField_H
 
#include "fvPatchFields.H"
#include "immersedBoundaryFvPatchField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace incompressible
{
namespace RASModels
{
 
/*---------------------------------------------------------------------------*\
         Class immersedBoundaryWallFunctionFvPatchField Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class immersedBoundaryWallFunctionFvPatchField
:
    public immersedBoundaryFvPatchField<Type>
{
    // Private data
 
        //- Value to fix in IB cell
        mutable Field<Type> wallValue_;
 
        //- Indicator on values to fix
        mutable boolList wallMask_;
 
 
protected:
 
    // Protected Member Functions
 
        //- Set IB cell values: contains data manipulation
        virtual void setIbCellValues(const Field<Type>&) const;
 
 
public:
 
    //- Runtime type information
    TypeName("immersedBoundaryWallFunction");
 
 
    // Constructors
 
        //- Construct from patch and internal field
        immersedBoundaryWallFunctionFvPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, volMesh>&
        );
 
        //- Construct from patch, internal field and dictionary
        immersedBoundaryWallFunctionFvPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, volMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given
        // immersedBoundaryWallFunctionFvPatchField
        //  onto a new patch
        immersedBoundaryWallFunctionFvPatchField
        (
            const immersedBoundaryWallFunctionFvPatchField&,
            const fvPatch&,
            const DimensionedField<Type, volMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Construct as copy
        immersedBoundaryWallFunctionFvPatchField
        (
            const immersedBoundaryWallFunctionFvPatchField&
        );
 
        //- Construct and return a clone
        virtual tmp<fvPatchField<Type> > clone() const
        {
            return tmp<fvPatchField<Type> >
            (
                new immersedBoundaryWallFunctionFvPatchField(*this)
            );
        }
 
        //- Construct as copy setting internal field reference
        immersedBoundaryWallFunctionFvPatchField
        (
            const immersedBoundaryWallFunctionFvPatchField&,
            const DimensionedField<Type, volMesh>&
        );
 
        //- Construct and return a clone setting internal field reference
        virtual tmp<fvPatchField<Type> > clone
        (
            const DimensionedField<Type, volMesh>& iF
        ) const
        {
            return tmp<fvPatchField<Type> >
            (
                new immersedBoundaryWallFunctionFvPatchField(*this, iF)
            );
        }
 
 
    //- Destructor
    virtual ~immersedBoundaryWallFunctionFvPatchField()
    {}
 
 
    // Member functions
 
        // Access
 
            //- Access to value to fix in IB cell.  Note non-const access
            Field<Type>& wallValue() const;
 
            //- Access to indicator on fixed values.  Note non-const access
            boolList& wallMask() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace RASModels
} // End namespace incompressible
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "immersedBoundaryWallFunctionFvPatchField.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //