Finite area patch class. Used for 2-D non-Euclidian finite area method. More...
Public Types | |
typedef faBoundaryMesh | BoundaryMesh |
![]() | |
typedef SubList< T > | subList |
Declare type of subList. More... | |
Public Member Functions | |
TypeName ("patch") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, faPatch, dictionary,(const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm),(name, dict, index, bm)) | |
faPatch (const word &name, const labelList &edgeLabels, const label index, const faBoundaryMesh &bm, const label ngbPolyPatchIndex) | |
Construct from components. More... | |
faPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm) | |
Construct from dictionary. More... | |
faPatch (const faPatch &, const faBoundaryMesh &) | |
Construct as copy, resetting the boundary mesh. More... | |
virtual autoPtr< faPatch > | clone (const faBoundaryMesh &bm, const labelList &edgeLabels, const label index, const label ngbPolyPatchIndex) const |
virtual | ~faPatch () |
Destructor. More... | |
const labelList & | edgeLabels () const noexcept |
Return the list of edges. More... | |
void | edgeLabels (const UList< label > &newEdgeLabels) |
Define new list of edges. More... | |
label | nPoints () const |
Number of patch points. More... | |
label | nEdges () const noexcept |
Number of edge labels (boundary edges) addressed by this patch. More... | |
label | ngbPolyPatchIndex () const noexcept |
The neighbour polyPatch index. More... | |
const faBoundaryMesh & | boundaryMesh () const noexcept |
Return boundaryMesh reference. More... | |
virtual bool | coupled () const |
Return true if this patch is coupled. More... | |
label | start () const |
Patch start in edge list. More... | |
virtual label | size () const |
Patch size is the number of edge labels. More... | |
label | whichEdge (const label l) const |
Return label of edge in patch from global edge label. More... | |
template<class T > | |
List< T >::subList | patchSlice (const List< T > &l) const |
Slice list to patch. More... | |
virtual void | write (Ostream &) const |
Write. More... | |
List< labelPair > | boundaryConnections () const |
labelList | boundaryProcs () const |
List< labelPair > | boundaryProcSizes () const |
const labelList & | pointLabels () const |
Return patch point labels. More... | |
const labelListList & | pointEdges () const |
Return patch point-edge addressing. More... | |
tmp< vectorField > | ngbPolyPatchFaceNormals () const |
Return normals of neighbour polyPatch faces. More... | |
tmp< vectorField > | ngbPolyPatchPointNormals () const |
Return normals of neighbour polyPatch joined points. More... | |
const labelUList & | edgeFaces () const |
Return edge-face addressing. More... | |
const vectorField & | edgeCentres () const |
Return edge centres. More... | |
const vectorField & | edgeLengths () const |
Return edge length vectors. More... | |
const scalarField & | magEdgeLengths () const |
Return edge length magnitudes. More... | |
tmp< vectorField > | edgeNormals () const |
Return edge normals. More... | |
tmp< vectorField > | edgeFaceCentres () const |
Return neighbour face centres. More... | |
virtual tmp< vectorField > | delta () const |
Return cell-centre to face-centre vector. More... | |
virtual void | makeWeights (scalarField &) const |
Make patch weighting factors. More... | |
const scalarField & | weights () const |
Return patch weighting factors. More... | |
virtual void | makeDeltaCoeffs (scalarField &) const |
Make patch edge - neighbour face distances. More... | |
void | makeCorrectionVectors (vectorField &) const |
const scalarField & | deltaCoeffs () const |
Return patch edge - neighbour face distances. More... | |
void | resetEdges (const UList< label > &newEdges) |
Reset the list of edges (use with caution) More... | |
void | resetEdges (labelList &&newEdges) |
Reset the list of edges (use with caution) More... | |
template<class Type > | |
tmp< Field< Type > > | patchInternalField (const UList< Type > &) const |
Return given internal field next to patch as patch field. More... | |
template<class Type > | |
tmp< Foam::Field< Type > > | patchInternalField (const UList< Type > &f, const labelUList &edgeFaces) const |
Return given internal field next to patch as patch field. More... | |
template<class GeometricField , class Type > | |
const GeometricField::Patch & | patchField (const GeometricField &) const |
Return the corresponding patchField of the named field. More... | |
template<class GeometricField , class Type > | |
const GeometricField::Patch & | lookupPatchField (const word &name, const GeometricField *=nullptr, const Type *=nullptr) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | patchInternalField (const UList< Type > &f) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | patchInternalField (const UList< Type > &f, const labelUList &edgeFaces) const |
![]() | |
patchIdentifier (const patchIdentifier &)=default | |
Copy construct. More... | |
patchIdentifier & | operator= (const patchIdentifier &)=default |
Copy assignment. More... | |
virtual | ~patchIdentifier ()=default |
Destructor. More... | |
patchIdentifier () | |
Default construct. Uses name="", index=0. More... | |
patchIdentifier (const word &name, const label index) | |
Construct from mandatory components. More... | |
patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList()) | |
Construct from components. More... | |
patchIdentifier (const word &name, const dictionary &dict, const label index) | |
Construct from dictionary. More... | |
patchIdentifier (const patchIdentifier &ident, const label index) | |
Copy construct, resetting the index. More... | |
const word & | name () const noexcept |
The patch name. More... | |
word & | name () noexcept |
Modifiable patch name. More... | |
label | index () const noexcept |
The index of this patch in the boundaryMesh. More... | |
label & | index () noexcept |
Modifiable index of this patch in the boundaryMesh. More... | |
const word & | physicalType () const noexcept |
The (optional) physical type of the patch. More... | |
word & | physicalType () noexcept |
Modifiable (optional) physical type of the patch. More... | |
const wordList & | inGroups () const noexcept |
The (optional) groups that the patch belongs to. More... | |
wordList & | inGroups () noexcept |
Modifiable (optional) groups that the patch belongs to. More... | |
bool | inGroup (const word &name) const |
True if given name is in a group. More... | |
void | write (Ostream &os) const |
![]() | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const T &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const T &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, T &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< T > &a) | |
Copy construct from list. More... | |
List (const UList< T > &a) | |
Copy construct contents from list. More... | |
List (List< T > &a, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< T > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
template<unsigned N> | |
List (const UList< T > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
template<unsigned N> | |
List (const FixedList< T, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< T > &list) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< T > &list) | |
Construct as copy of SLList<T> More... | |
template<class Addr > | |
List (const IndirectListBase< T, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< T > list) | |
Construct from an initializer list. More... | |
List (List< T > &&list) | |
Move construct from List. More... | |
template<int SizeMin> | |
List (DynamicList< T, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (SortableList< T > &&list) | |
Move construct from SortableList. More... | |
List (SLList< T > &&list) | |
Move construct from SLList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
autoPtr< List< T > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const T &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const T &val) |
Alias for resize() More... | |
void | append (const T &val) |
Append an element at the end of the list. More... | |
void | append (T &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< T > &list) |
Append a List to the end of this list. More... | |
template<class Addr > | |
void | append (const IndirectListBase< T, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const T &val) |
Append an element if not already in the list. More... | |
void | transfer (List< T > &list) |
template<int SizeMin> | |
void | transfer (DynamicList< T, SizeMin > &list) |
void | transfer (SortableList< T > &list) |
T & | newElmt (const label i) |
void | operator= (const UList< T > &a) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< T > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const SLList< T > &list) |
Assignment to SLList operator. Takes linear time. More... | |
template<class Addr > | |
void | operator= (const IndirectListBase< T, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
template<unsigned N> | |
void | operator= (const FixedList< T, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< T > list) |
Assignment to an initializer list. More... | |
void | operator= (const T &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< T > &&list) |
Move assignment. Takes constant time. More... | |
template<int SizeMin> | |
void | operator= (DynamicList< T, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SortableList< T > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (SLList< T > &&list) |
Move assignment. Takes constant time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< T > &)=delete |
No shallowCopy permitted. More... | |
template<class TypeT = T> | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
template<> | |
Istream & | readList (Istream &is) |
template<> | |
void | resize (const label newLen) |
template<> | |
Istream & | readList (Istream &is) |
Static Public Member Functions | |
static autoPtr< faPatch > | New (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm) |
![]() | |
static word | defaultName (const label n=-1) |
Default patch name: "patch" or "patchN". More... | |
![]() | |
static const List< T > & | null () |
Return a null List. More... | |
Protected Member Functions | |
void | calcPointLabels () const |
Calculate patch point labels. More... | |
void | calcPointEdges () const |
Calculate patch point-edge addressing. More... | |
virtual void | initGeometry () |
Initialise the calculation of the patch geometry. More... | |
virtual void | calcGeometry () |
Calculate the patch geometry. More... | |
virtual void | initMovePoints (const pointField &) |
Initialise the patches for moving points. More... | |
virtual void | movePoints (const pointField &) |
Correct patch after moving points. More... | |
virtual void | initUpdateMesh () |
Initialise the update of the patch topology. More... | |
virtual void | updateMesh () |
Update of the patch topology. More... | |
Friends | |
class | faBoundaryMesh |
The faPatch geometry initialisation is called by faBoundaryMesh. More... | |
Ostream & | operator<< (Ostream &, const faPatch &) |
Finite area patch class. Used for 2-D non-Euclidian finite area method.
typedef faBoundaryMesh BoundaryMesh |
faPatch | ( | const word & | name, |
const labelList & | edgeLabels, | ||
const label | index, | ||
const faBoundaryMesh & | bm, | ||
const label | ngbPolyPatchIndex | ||
) |
faPatch | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index, | ||
const faBoundaryMesh & | bm | ||
) |
faPatch | ( | const faPatch & | p, |
const faBoundaryMesh & | bm | ||
) |
|
protected |
Calculate patch point labels.
const labelList& edgePoints = *pointLabelsPtr_;
// Cannot use invertManyToMany - we have non-local edge numbering
// Intermediate storage for pointEdges. // Points on the boundary will normally connect 1 or 2 edges only. List<DynamicList<label,2>> dynPointEdges(edgePoints.size());
forAll(edges, edgei) { const edge& e = edges[edgei];
dynPointEdges[markedPoints[e.first()]].append(edgei); dynPointEdges[markedPoints[e.second()]].append(edgei); }
// Flatten to regular list pointEdgesPtr_ = new labelListList(edgePoints.size()); auto& pEdges = *pointEdgesPtr_;
forAll(pEdges, pointi) { pEdges[pointi] = std::move(dynPointEdges[pointi]); }
Definition at line 224 of file faPatch.C.
References DynamicList< T, SizeMin >::append(), Foam::constant::electromagnetic::e, and mesh.
|
protected |
Calculate patch point-edge addressing.
Definition at line 281 of file faPatch.C.
References append(), Foam::constant::electromagnetic::e, forAll, mesh, and pointLabels().
|
inlineprotectedvirtual |
Initialise the calculation of the patch geometry.
Reimplemented in coupledFaPatch, cyclicFaPatch, and processorFaPatch.
Definition at line 118 of file faPatch.H.
Referenced by cyclicFaPatch::initGeometry().
|
inlineprotectedvirtual |
Calculate the patch geometry.
Reimplemented in coupledFaPatch, cyclicFaPatch, and processorFaPatch.
Definition at line 122 of file faPatch.H.
Referenced by cyclicFaPatch::calcGeometry().
|
inlineprotectedvirtual |
Initialise the patches for moving points.
Reimplemented in coupledFaPatch, cyclicFaPatch, and processorFaPatch.
Definition at line 126 of file faPatch.H.
Referenced by cyclicFaPatch::initMovePoints().
|
protectedvirtual |
Correct patch after moving points.
Reimplemented in coupledFaPatch, cyclicFaPatch, and processorFaPatch.
Definition at line 463 of file faPatch.C.
Referenced by processorFaPatch::initMovePoints(), and cyclicFaPatch::movePoints().
|
inlineprotectedvirtual |
Initialise the update of the patch topology.
Reimplemented in processorFaPatch.
Definition at line 133 of file faPatch.H.
Referenced by processorFaPatch::initUpdateMesh().
|
inlineprotectedvirtual |
Update of the patch topology.
Reimplemented in processorFaPatch.
Definition at line 137 of file faPatch.H.
Referenced by processorFaPatch::updateMesh().
TypeName | ( | "patch" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
faPatch | , | ||
dictionary | , | ||
(const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm) | , | ||
(name, dict, index, bm) | |||
) |
|
inlinevirtual |
Construct and return a clone, resetting the edge list and boundary mesh
Reimplemented in emptyFaPatch, and symmetryFaPatch.
Definition at line 192 of file faPatch.H.
References faPatch::edgeLabels(), patchIdentifier::index(), patchIdentifier::name(), autoPtr< T >::New(), and faPatch::ngbPolyPatchIndex().
|
static |
Return a pointer to a new patch created on freestore from dictionary
Definition at line 35 of file faPatchNew.C.
References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::name().
|
inlinenoexcept |
Return the list of edges.
Definition at line 225 of file faPatch.H.
Referenced by faPatchData::assign(), symmetryFaPatch::clone(), emptyFaPatch::clone(), and faPatch::clone().
void edgeLabels | ( | const UList< label > & | newEdgeLabels | ) |
Define new list of edges.
|
inline |
Number of patch points.
Definition at line 234 of file faPatch.H.
References faPatch::pointLabels().
|
inlinenoexcept |
|
inlinenoexcept |
The neighbour polyPatch index.
Definition at line 246 of file faPatch.H.
Referenced by faPatchData::assign(), symmetryFaPatch::clone(), emptyFaPatch::clone(), and faPatch::clone().
|
noexcept |
Return boundaryMesh reference.
|
inlinevirtual |
Return true if this patch is coupled.
Reimplemented in processorFaPatch, and coupledFaPatch.
Foam::label start | ( | ) | const |
Patch start in edge list.
Definition at line 126 of file faPatch.C.
References boundaryMesh::mesh().
Referenced by faPatch::patchSlice(), and faPatch::whichEdge().
|
inlinevirtual |
Patch size is the number of edge labels.
Reimplemented in emptyFaPatch.
Definition at line 264 of file faPatch.H.
Referenced by faMeshDecomposition::decomposeMesh(), processorFaPatch::interfaceSize(), faPatch::patchSlice(), and faPatchMapper::size().
|
inline |
Return label of edge in patch from global edge label.
Definition at line 270 of file faPatch.H.
References faPatch::start().
Slice list to patch.
Definition at line 277 of file faPatch.H.
References faPatch::size(), and faPatch::start().
Referenced by faFieldDecomposer::reset().
|
virtual |
Write.
Reimplemented in processorFaPatch.
Definition at line 481 of file faPatch.C.
References os(), Foam::type(), patchIdentifier::write(), and Ostream::writeEntry().
Referenced by processorFaPatch::write().
Foam::List< Foam::labelPair > boundaryConnections | ( | ) | const |
List of proc/face for the boundary edge neighbours in locally reordered edge numbering.
Definition at line 132 of file faPatch.C.
References Foam::BitOps::count(), boundaryMesh::mesh(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), and Foam::output().
Foam::labelList boundaryProcs | ( | ) | const |
Boundary edge neighbour processors (does not include own proc)
Definition at line 152 of file faPatch.C.
References HashSet< Key, Hash >::insert(), boundaryMesh::mesh(), UPstream::myProcNo(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), and UPstream::nProcs().
Foam::List< Foam::labelPair > boundaryProcSizes | ( | ) | const |
List of proc/size for the boundary edge neighbour processors (does not include own proc)
Definition at line 172 of file faPatch.C.
References Foam::BitOps::count(), boundaryMesh::mesh(), UPstream::myProcNo(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), UPstream::nProcs(), and Foam::output().
const Foam::labelList & pointLabels | ( | ) | const |
Return patch point labels.
Definition at line 202 of file faPatch.C.
Referenced by faPatch::nPoints(), and faGlobalMeshData::updateMesh().
const Foam::labelListList & pointEdges | ( | ) | const |
Foam::tmp< Foam::vectorField > ngbPolyPatchFaceNormals | ( | ) | const |
Return normals of neighbour polyPatch faces.
Same as faMesh::haloFaceNormals()
Definition at line 312 of file faPatch.C.
References boundaryMesh::mesh(), and tmp< T >::New().
Foam::tmp< Foam::vectorField > ngbPolyPatchPointNormals | ( | ) | const |
Return normals of neighbour polyPatch joined points.
Definition at line 323 of file faPatch.C.
References faceNormals(), forAll, mesh, n, tmp< T >::New(), and Foam::Zero.
const Foam::labelUList & edgeFaces | ( | ) | const |
Return edge-face addressing.
Definition at line 358 of file faPatch.C.
References mesh.
Referenced by contactAngleForce::correct(), faMeshDecomposition::decomposeMesh(), and coupledFaPatch::faceCells().
const Foam::vectorField & edgeCentres | ( | ) | const |
Return edge centres.
Definition at line 372 of file faPatch.C.
References boundaryMesh::mesh().
const Foam::vectorField & edgeLengths | ( | ) | const |
Return edge length vectors.
Definition at line 378 of file faPatch.C.
References boundaryMesh::mesh().
const Foam::scalarField & magEdgeLengths | ( | ) | const |
Return edge length magnitudes.
Definition at line 384 of file faPatch.C.
References boundaryMesh::mesh().
Foam::tmp< Foam::vectorField > edgeNormals | ( | ) | const |
Return edge normals.
Definition at line 390 of file faPatch.C.
References n, and tmp< T >::New().
Foam::tmp< Foam::vectorField > edgeFaceCentres | ( | ) | const |
Return neighbour face centres.
Definition at line 403 of file faPatch.C.
References forAll, boundaryMesh::mesh(), and tmp< T >::New().
|
virtual |
Return cell-centre to face-centre vector.
except for coupled patches for which the cell-centre to coupled-cell-centre vector is returned
Reimplemented in coupledFaPatch, processorFaPatch, and cyclicFaPatch.
Definition at line 423 of file faPatch.C.
Referenced by cyclicFaPatch::delta(), processorFaPatch::delta(), cyclicFaPatch::makeDeltaCoeffs(), processorFaPatch::makeDeltaCoeffs(), cyclicFaPatch::makeWeights(), and processorFaPatch::makeWeights().
|
virtual |
Make patch weighting factors.
Reimplemented in coupledFaPatch, processorFaPatch, and cyclicFaPatch.
const Foam::scalarField & weights | ( | ) | const |
Return patch weighting factors.
Definition at line 457 of file faPatch.C.
References boundaryMesh::mesh().
|
virtual |
Make patch edge - neighbour face distances.
Reimplemented in coupledFaPatch, processorFaPatch, and cyclicFaPatch.
Definition at line 429 of file faPatch.C.
References delta.
void makeCorrectionVectors | ( | vectorField & | k | ) | const |
Definition at line 435 of file faPatch.C.
References delta, k, and Foam::mag().
const Foam::scalarField & deltaCoeffs | ( | ) | const |
Return patch edge - neighbour face distances.
Definition at line 445 of file faPatch.C.
References boundaryMesh::mesh().
void resetEdges | ( | const UList< label > & | newEdges | ) |
void resetEdges | ( | labelList && | newEdges | ) |
Return given internal field next to patch as patch field.
tmp<Foam::Field<Type> > patchInternalField | ( | const UList< Type > & | f, |
const labelUList & | edgeFaces | ||
) | const |
Return given internal field next to patch as patch field.
providing addressing
const GeometricField::Patch & patchField | ( | const GeometricField & | gf | ) | const |
Return the corresponding patchField of the named field.
Definition at line 64 of file faPatchTemplates.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField().
const GeometricField::Patch & lookupPatchField | ( | const word & | name, |
const GeometricField * | = nullptr , |
||
const Type * | = nullptr |
||
) | 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
Definition at line 35 of file faPatchFaMeshTemplates.C.
References mesh, and Foam::name().
Foam::tmp<Foam::Field<Type> > patchInternalField | ( | const UList< Type > & | f | ) | const |
Definition at line 35 of file faPatchTemplates.C.
References f().
Foam::tmp<Foam::Field<Type> > patchInternalField | ( | const UList< Type > & | f, |
const labelUList & | edgeFaces | ||
) | const |
Definition at line 45 of file faPatchTemplates.C.
References f(), forAll, and Foam::New().
|
friend |
The faPatch geometry initialisation is called by faBoundaryMesh.