emptyFaPatch Class Reference

A patch which will not exist in the faMesh. Typical example is a front and back plane of a 2-D geometry. More...

Inheritance diagram for emptyFaPatch:
[legend]
Collaboration diagram for emptyFaPatch:
[legend]

Public Member Functions

 TypeName ("empty")
 Runtime type information. More...
 
 emptyFaPatch (const word &name, const label index, const faBoundaryMesh &bm, const label ngbPolyPatchIndex=-1)
 Minimal construct from components. More...
 
 emptyFaPatch (const word &name, const labelList &edgeLabels, const label index, const faBoundaryMesh &bm, const label ngbPolyPatchIndex)
 Construct from components. More...
 
 emptyFaPatch (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 Construct from dictionary. More...
 
virtual autoPtr< faPatchclone (const faBoundaryMesh &bm, const labelList &edgeLabels, const label index, const label ngbPolyPatchIndex) const
 Construct and return a clone, resetting the edge list. More...
 
virtual label size () const
 Patch size is the number of edge labels. More...
 
- Public Member Functions inherited from faPatch
 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 ~faPatch ()
 Destructor. More...
 
const labelListedgeLabels () 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 faBoundaryMeshboundaryMesh () 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...
 
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< labelPairboundaryConnections () const
 
labelList boundaryProcs () const
 
List< labelPairboundaryProcSizes () const
 
const labelListpointLabels () const
 Return patch point labels. More...
 
const labelListListpointEdges () const
 Return patch point-edge addressing. More...
 
tmp< vectorFieldngbPolyPatchFaceNormals () const
 Return normals of neighbour polyPatch faces. More...
 
tmp< vectorFieldngbPolyPatchPointNormals () const
 Return normals of neighbour polyPatch joined points. More...
 
const labelUListedgeFaces () const
 Return edge-face addressing. More...
 
const vectorFieldedgeCentres () const
 Return edge centres. More...
 
const vectorFieldedgeLengths () const
 Return edge length vectors. More...
 
const scalarFieldmagEdgeLengths () const
 Return edge length magnitudes. More...
 
tmp< vectorFieldedgeNormals () const
 Return edge normals. More...
 
tmp< vectorFieldedgeFaceCentres () const
 Return neighbour face centres. More...
 
virtual tmp< vectorFielddelta () const
 Return cell-centre to face-centre vector. More...
 
virtual void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
virtual void makeDeltaCoeffs (scalarField &) const
 Make patch edge - neighbour face distances. More...
 
void makeCorrectionVectors (vectorField &) const
 
const scalarFielddeltaCoeffs () 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::PatchpatchField (const GeometricField &) const
 Return the corresponding patchField of the named field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchlookupPatchField (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
 
- Public Member Functions inherited from patchIdentifier
 patchIdentifier (const patchIdentifier &)=default
 Copy construct. More...
 
patchIdentifieroperator= (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 wordname () const noexcept
 The patch name. More...
 
wordname () 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 wordphysicalType () const noexcept
 The (optional) physical type of the patch. More...
 
wordphysicalType () noexcept
 Modifiable (optional) physical type of the patch. More...
 
const wordListinGroups () const noexcept
 The (optional) groups that the patch belongs to. More...
 
wordListinGroups () 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
 
- Public Member Functions inherited from List< T >
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)
 
TnewElmt (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...
 
IstreamreadList (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<>
IstreamreadList (Istream &is)
 
template<>
void resize (const label newLen)
 
template<>
IstreamreadList (Istream &is)
 

Additional Inherited Members

- Public Types inherited from faPatch
typedef faBoundaryMesh BoundaryMesh
 
- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from faPatch
static autoPtr< faPatchNew (const word &name, const dictionary &dict, const label index, const faBoundaryMesh &bm)
 
- Static Public Member Functions inherited from patchIdentifier
static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN". More...
 
- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List. More...
 
- Protected Member Functions inherited from faPatch
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...
 

Detailed Description

A patch which will not exist in the faMesh. Typical example is a front and back plane of a 2-D geometry.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 56 of file emptyFaPatch.H.

Constructor & Destructor Documentation

◆ emptyFaPatch() [1/3]

emptyFaPatch ( const word name,
const label  index,
const faBoundaryMesh bm,
const label  ngbPolyPatchIndex = -1 
)

Minimal construct from components.

Definition at line 48 of file emptyFaPatch.C.

◆ emptyFaPatch() [2/3]

emptyFaPatch ( const word name,
const labelList edgeLabels,
const label  index,
const faBoundaryMesh bm,
const label  ngbPolyPatchIndex 
)

Construct from components.

Definition at line 60 of file emptyFaPatch.C.

◆ emptyFaPatch() [3/3]

emptyFaPatch ( const word name,
const dictionary dict,
const label  index,
const faBoundaryMesh bm 
)
inline

Construct from dictionary.

Definition at line 89 of file emptyFaPatch.H.

Member Function Documentation

◆ TypeName()

TypeName ( "empty"  )

Runtime type information.

◆ clone()

virtual autoPtr<faPatch> clone ( const faBoundaryMesh bm,
const labelList edgeLabels,
const label  index,
const label  ngbPolyPatchIndex 
) const
inlinevirtual

Construct and return a clone, resetting the edge list.

and boundary mesh

Reimplemented from faPatch.

Definition at line 102 of file emptyFaPatch.H.

References faPatch::edgeLabels(), patchIdentifier::index(), patchIdentifier::name(), and faPatch::ngbPolyPatchIndex().

Here is the call graph for this function:

◆ size()

virtual label size ( ) const
inlinevirtual

Patch size is the number of edge labels.

Reimplemented from faPatch.

Definition at line 125 of file emptyFaPatch.H.


The documentation for this class was generated from the following files: