mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
411 lines
11 KiB
C++
411 lines
11 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2016-2017 Wikki Ltd
|
|
Copyright (C) 2020-2021 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::faPatch
|
|
|
|
Description
|
|
Finite area patch class. Used for 2-D non-Euclidian finite area method.
|
|
|
|
Author
|
|
Zeljko Tukovic, FMENA
|
|
Hrvoje Jasak, Wikki Ltd.
|
|
|
|
SourceFiles
|
|
faPatch.C
|
|
faPatchNew.C
|
|
faPatchTemplates.C
|
|
faPatchFaMeshTemplates.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef faPatch_H
|
|
#define faPatch_H
|
|
|
|
#include "patchIdentifier.H"
|
|
#include "labelList.H"
|
|
#include "pointField.H"
|
|
#include "typeInfo.H"
|
|
#include "faPatchFieldsFwd.H"
|
|
#include "autoPtr.H"
|
|
#include "runTimeSelectionTables.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward Declarations
|
|
class faBoundaryMesh;
|
|
class faPatch;
|
|
Ostream& operator<<(Ostream&, const faPatch&);
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class faPatch Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class faPatch
|
|
:
|
|
public labelList,
|
|
public patchIdentifier
|
|
{
|
|
// Private Data
|
|
|
|
//- Neighbour polyPatch index
|
|
const label nbrPolyPatchId_;
|
|
|
|
//- Reference to boundary mesh
|
|
const faBoundaryMesh& boundaryMesh_;
|
|
|
|
|
|
// Demand-driven private data
|
|
|
|
//- Edge-face addressing
|
|
mutable labelList::subList* edgeFacesPtr_;
|
|
|
|
//- Local points labels
|
|
mutable labelList* pointLabelsPtr_;
|
|
|
|
//- Point-edge addressing
|
|
mutable labelListList* pointEdgesPtr_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- No copy construct
|
|
faPatch(const faPatch&) = delete;
|
|
|
|
//- No copy assignment
|
|
void operator=(const faPatch&) = delete;
|
|
|
|
//- Clear out topological patch data
|
|
void clearOut();
|
|
|
|
|
|
protected:
|
|
|
|
// Protected Member Functions
|
|
|
|
//- The faPatch geometry initialisation is called by faBoundaryMesh
|
|
friend class faBoundaryMesh;
|
|
|
|
//- Calculate patch point labels
|
|
void calcPointLabels() const;
|
|
|
|
//- Calculate patch point-edge addressing
|
|
void calcPointEdges() const;
|
|
|
|
//- Initialise the calculation of the patch geometry
|
|
virtual void initGeometry()
|
|
{}
|
|
|
|
//- Calculate the patch geometry
|
|
virtual void calcGeometry()
|
|
{}
|
|
|
|
//- Initialise the patches for moving points
|
|
virtual void initMovePoints(const pointField&)
|
|
{}
|
|
|
|
//- Correct patch after moving points
|
|
virtual void movePoints(const pointField&);
|
|
|
|
//- Initialise the update of the patch topology
|
|
virtual void initUpdateMesh()
|
|
{}
|
|
|
|
//- Update of the patch topology
|
|
virtual void updateMesh()
|
|
{}
|
|
|
|
|
|
public:
|
|
|
|
typedef faBoundaryMesh BoundaryMesh;
|
|
|
|
//- Runtime type information
|
|
TypeName("patch");
|
|
|
|
// Declare run-time constructor selection tables
|
|
|
|
declareRunTimeSelectionTable
|
|
(
|
|
autoPtr,
|
|
faPatch,
|
|
dictionary,
|
|
(
|
|
const word& name,
|
|
const dictionary& dict,
|
|
const label index,
|
|
const faBoundaryMesh& bm
|
|
),
|
|
(name, dict, index, bm)
|
|
);
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from components
|
|
faPatch
|
|
(
|
|
const word& name,
|
|
const labelList& edgeLabels,
|
|
const label index,
|
|
const faBoundaryMesh& bm,
|
|
const label ngbPolyPatchIndex
|
|
);
|
|
|
|
//- Construct from dictionary
|
|
faPatch
|
|
(
|
|
const word& name,
|
|
const dictionary& dict,
|
|
const label index,
|
|
const faBoundaryMesh& bm
|
|
);
|
|
|
|
//- Construct as copy, resetting the boundary mesh
|
|
faPatch(const faPatch&, const faBoundaryMesh&);
|
|
|
|
//- Construct and return a clone, resetting the edge list
|
|
//- and boundary mesh
|
|
virtual autoPtr<faPatch> clone
|
|
(
|
|
const faBoundaryMesh& bm,
|
|
const labelList& edgeLabels,
|
|
const label index,
|
|
const label ngbPolyPatchIndex
|
|
) const
|
|
{
|
|
return
|
|
autoPtr<faPatch>::New
|
|
(name(), edgeLabels, index, bm, ngbPolyPatchIndex);
|
|
}
|
|
|
|
|
|
// Selectors
|
|
|
|
//- Return a pointer to a new patch created
|
|
//- on freestore from dictionary
|
|
static autoPtr<faPatch> New
|
|
(
|
|
const word& name,
|
|
const dictionary& dict,
|
|
const label index,
|
|
const faBoundaryMesh& bm
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~faPatch();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Return the list of edges
|
|
const labelList& edgeLabels() const noexcept
|
|
{
|
|
return static_cast<const labelList&>(*this);
|
|
}
|
|
|
|
void edgeLabels(const UList<label>& newEdgeLabels);
|
|
|
|
//- Number of patch points
|
|
label nPoints() const
|
|
{
|
|
return pointLabels().size();
|
|
}
|
|
|
|
//- Number of edge labels (boundary edges) addressed by this patch
|
|
label nEdges() const noexcept
|
|
{
|
|
return labelList::size();
|
|
}
|
|
|
|
//- Return neighbour polyPatch index
|
|
label ngbPolyPatchIndex() const noexcept;
|
|
|
|
//- Return boundaryMesh reference
|
|
const faBoundaryMesh& boundaryMesh() const noexcept;
|
|
|
|
//- Return true if this patch is coupled
|
|
virtual bool coupled() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
//- Patch start in edge list
|
|
label start() const;
|
|
|
|
//- Patch size is the number of edge labels
|
|
virtual label size() const
|
|
{
|
|
return labelList::size();
|
|
}
|
|
|
|
//- Return label of edge in patch from global edge label
|
|
inline label whichEdge(const label l) const
|
|
{
|
|
return l - start();
|
|
}
|
|
|
|
//- Slice list to patch
|
|
template<class T>
|
|
typename List<T>::subList patchSlice(const List<T>& l) const
|
|
{
|
|
return typename List<T>::subList(l, size(), start());
|
|
}
|
|
|
|
|
|
//- Write
|
|
virtual void write(Ostream&) const;
|
|
|
|
|
|
// Access functions for geometrical data
|
|
|
|
//- Return patch point labels
|
|
const labelList& pointLabels() const;
|
|
|
|
//- Return patch point-edge addressing
|
|
const labelListList& pointEdges() const;
|
|
|
|
//- Return edge neighbour polyPatch faces
|
|
labelList ngbPolyPatchFaces() const;
|
|
|
|
//- Return normals of neighbour polyPatch faces
|
|
tmp<vectorField> ngbPolyPatchFaceNormals() const;
|
|
|
|
//- Return normals of neighbour polyPatch joined points
|
|
tmp<vectorField> ngbPolyPatchPointNormals() const;
|
|
|
|
//- Return edge-face addressing
|
|
const labelUList& edgeFaces() const;
|
|
|
|
//- Return edge centres
|
|
const vectorField& edgeCentres() const;
|
|
|
|
//- Return edge length vectors
|
|
const vectorField& edgeLengths() const;
|
|
|
|
//- Return edge length magnitudes
|
|
const scalarField& magEdgeLengths() const;
|
|
|
|
//- Return edge normals
|
|
tmp<vectorField> edgeNormals() const;
|
|
|
|
//- Return neighbour face centres
|
|
tmp<vectorField> edgeFaceCentres() const;
|
|
|
|
//- Return cell-centre to face-centre vector
|
|
// except for coupled patches for which the cell-centre
|
|
// to coupled-cell-centre vector is returned
|
|
virtual tmp<vectorField> delta() const;
|
|
|
|
|
|
// Access functions for demand driven data
|
|
|
|
//- Make patch weighting factors
|
|
virtual void makeWeights(scalarField&) const;
|
|
|
|
//- Return patch weighting factors
|
|
const scalarField& weights() const;
|
|
|
|
//- Make patch edge - neighbour face distances
|
|
virtual void makeDeltaCoeffs(scalarField&) const;
|
|
|
|
void makeCorrectionVectors(vectorField&) const;
|
|
|
|
//- Return patch edge - neighbour face distances
|
|
const scalarField& deltaCoeffs() const;
|
|
|
|
|
|
// Topological changes
|
|
|
|
//- Reset the list of edges (use with caution)
|
|
void resetEdges(const UList<label>& newEdges);
|
|
|
|
//- Reset the list of edges (use with caution)
|
|
void resetEdges(labelList&& newEdges);
|
|
|
|
|
|
// Evaluation
|
|
|
|
//- Return given internal field next to patch as patch field
|
|
template<class Type>
|
|
tmp<Field<Type>> patchInternalField(const UList<Type>&) const;
|
|
|
|
//- Return given internal field next to patch as patch field
|
|
// providing addressing
|
|
template<class Type>
|
|
tmp<Foam::Field<Type>> patchInternalField
|
|
(
|
|
const UList<Type>& f,
|
|
const labelUList& edgeFaces
|
|
) const;
|
|
|
|
//- Return the corresponding patchField of the named field
|
|
template<class GeometricField, class Type>
|
|
const typename GeometricField::Patch& patchField
|
|
(
|
|
const GeometricField&
|
|
) const;
|
|
|
|
//- Lookup and return the patchField of the named field from the
|
|
//- local objectRegistry.
|
|
// N.B. The dummy pointer arguments are used if this function is
|
|
// instantiated within a templated function to avoid a bug in gcc.
|
|
// See inletOutletFvPatchField.C and outletInletFvPatchField.C
|
|
template<class GeometricField, class Type>
|
|
const typename GeometricField::Patch& lookupPatchField
|
|
(
|
|
const word& name,
|
|
const GeometricField* = nullptr,
|
|
const Type* = nullptr
|
|
) const;
|
|
|
|
|
|
// Ostream Operator
|
|
|
|
friend Ostream& operator<<(Ostream&, const faPatch&);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "faPatchTemplates.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|