mappedFvPatchField.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) 2011-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::mappedFvPatchField
 
Description
    Base class for mapped patch fields
 
Usage
    \table
        Property     | Description                | Required | Default value
        field        | name of field to be mapped | no       | this field name
        setAverage   | set the average value?     | no       | yes if average \\
                                                               is specified, \\
                                                               no otherwise
        average      | average value to apply     | if setAverage is true |
    \endtable
 
    This boundary condition will usually be applied to a patch which is of
    mappedPatchBase type, and which holds all the necessary mapping
    information. It can also create its own mapping data which overrides that
    in the mapped patch, or so that it can be applied to a non-mapped patch.
    This is triggered by the presence of controls relating to mappedPatchBase
    (i.e., neighbourRegion, neighbourPatch, etc ...).
 
See also
    Foam::mappedValueFvPatchField
    Foam::mappedPatchBase
    Foam::mappedPolyPatch
    Foam::mappedFvPatch
 
SourceFiles
    mappedFvPatchField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef mappedFvPatchField_H
#define mappedFvPatchField_H
 
#include "mappedPatchBase.H"
#include "fvPatchField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                   Class mappedFvPatchField Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class mappedFvPatchField
{
protected:
 
    // Protected Member Data
 
        //- Reference to the patch
        const fvPatch& p_;
 
        //- Reference to the internal field
        const DimensionedField<Type, volMesh>& iF_;
 
        //- The field to map
        const word fieldName_;
 
        //- If true adjust the sampled field to maintain an average value
        const bool setAverage_;
 
        //- Average value the sampled field is adjusted to
        const Type average_;
 
        //- The mapping engine
        autoPtr<mappedPatchBase> mapperPtr_;
 
 
    // Protected Member Functions
 
        //- Return the mapping engine
        const mappedPatchBase& mapper() const;
 
        //- Return the neighbouring patch field
        const fvPatchField<Type>& nbrPatchField() const;
 
        //- Return the mapped values, given the neighbouring field
        tmp<Field<Type>> mappedValues(const Field<Type>& nbrPatchField) const;
 
 
public:
 
    //- Runtime type information
    TypeName("mappedValue");
 
 
    // Constructors
 
        //- Construct from patch, internal field and dictionary
        mappedFvPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, volMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given mappedFvPatchField
        //  onto a new patch
        mappedFvPatchField
        (
            const mappedFvPatchField<Type>&,
            const fvPatch&,
            const DimensionedField<Type, volMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Disallow copy without setting internal field reference
        mappedFvPatchField
        (
            const mappedFvPatchField<Type>&
        ) = delete;
 
        //- Copy constructor setting internal field reference
        mappedFvPatchField
        (
            const mappedFvPatchField<Type>&,
            const DimensionedField<Type, volMesh>&
        );
 
 
    //- Destructor
    virtual ~mappedFvPatchField()
    {}
 
 
    // Member Functions
 
        //- Clear the mapper if present
        virtual void clearOut();
 
        //- Write
        virtual void write(Ostream&) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "mappedFvPatchField.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //