fvSurfaceMapper.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) 2011-2013 OpenFOAM Foundation
    Copyright (C) 2024 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::fvSurfaceMapper
 
Description
    A finiteVolume surface mapper.
 
SourceFiles
    fvSurfaceMapper.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_fvSurfaceMapper_H
#define Foam_fvSurfaceMapper_H
 
#include "morphFieldMapper.H"
#include "fvMesh.H"
#include "faceMapper.H"
#include "HashSet.H"
#include "mapPolyMesh.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                         Class fvSurfaceMapper Declaration
\*---------------------------------------------------------------------------*/
 
class fvSurfaceMapper
:
    public morphFieldMapper
{
    // Private Data
 
        //- Reference to mesh
        const fvMesh& mesh_;
 
        //- Reference to face mapper
        const faceMapper& faceMap_;
 
 
    // Demand-Driven Data
 
        //- Direct addressing (only one for of addressing is used)
        mutable std::unique_ptr<labelList> directAddrPtr_;
 
        //- Interpolated addressing (only one for of addressing is used)
        mutable std::unique_ptr<labelListList> interpAddrPtr_;
 
        //- Interpolation weights
        mutable std::unique_ptr<scalarListList> weightsPtr_;
 
        //- Inserted faces
        mutable std::unique_ptr<labelList> insertedObjectsPtr_;
 
 
 
    // Private Member Functions
 
        //- No copy construct
        fvSurfaceMapper(const fvSurfaceMapper&) = delete;
 
        //- No copy assignment
        void operator=(const fvSurfaceMapper&) = delete;
 
 
        //- Calculate addressing
        void calcAddressing() const;
 
 
public:
 
    // Constructors
 
        //- Construct from components
        fvSurfaceMapper
        (
            const fvMesh& mesh,
            const faceMapper& mapper
        );
 
 
    //- Destructor
    virtual ~fvSurfaceMapper();
 
 
    // Member Functions
 
        //- Return size
        virtual label size() const
        {
            return mesh_.nInternalFaces();
        }
 
        //- Return size of field before mapping
        virtual label sizeBeforeMapping() const
        {
            return faceMap_.internalSizeBeforeMapping();
        }
 
        //- Is the mapping direct
        virtual bool direct() const
        {
            return faceMap_.direct();
        }
 
        //- Has unmapped elements
        virtual bool hasUnmapped() const
        {
            return insertedObjects();
        }
 
        //- Return direct addressing
        virtual const labelUList& directAddressing() const;
 
        //- Return interpolated addressing
        virtual const labelListList& addressing() const;
 
        //- Return interpolation weights
        virtual const scalarListList& weights() const;
 
        //- Are there any inserted faces
        virtual bool insertedObjects() const
        {
            return faceMap_.insertedObjects();
        }
 
        //- Return list of inserted faces
        virtual const labelList& insertedObjectLabels() const;
 
        //- Return flux flip map
        const labelHashSet& flipFaceFlux() const
        {
            return faceMap_.flipFaceFlux();
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //