symmetryFaPatch Class Reference

Symmetry-plane patch. More...

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

Public Member Functions

 TypeName (symmetryPolyPatch::typeName_())
 Runtime type information. More...
 
 symmetryFaPatch (const word &name, const labelList &edgeLabels, const label index, const faBoundaryMesh &bm, const label ngbPolyPatchIndex)
 Construct from components. More...
 
 symmetryFaPatch (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 ~symmetryFaPatch ()=default
 Destructor. 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...
 
label nPoints () const
 Return number of patch points. More...
 
label ngbPolyPatchIndex () const
 Return neighbour polyPatch index. More...
 
const faBoundaryMeshboundaryMesh () const
 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. 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...
 
const labelListpointLabels () const
 Return patch point labels. More...
 
const labelListListpointEdges () const
 Return patch point-edge addressing. More...
 
labelList ngbPolyPatchFaces () const
 Return edge neighbour polyPatch faces. 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 labelList &)
 Reset edge list. 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 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
 
- Public Member Functions inherited from List< label >
constexpr List () noexcept
 Null constructor. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const label &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 label &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, label &&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< label > &a)
 Copy construct from list. More...
 
 List (const UList< label > &a)
 Copy construct contents from list. More...
 
 List (List< label > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< label > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< label > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (InputIterator begIter, InputIterator endIter)
 Construct given begin/end iterators. More...
 
 List (const FixedList< label, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< label > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< label > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< label, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< label > list)
 Construct from an initializer list. More...
 
 List (List< label > &&list)
 Move construct from List. More...
 
 List (DynamicList< label, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SortableList< label > &&list)
 Move construct from SortableList. More...
 
 List (SLList< label > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< label > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label newSize)
 Adjust allocated size of list. More...
 
void resize (const label newSize, const label &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newSize)
 
void setSize (const label newSize)
 Alias for resize(const label) More...
 
void setSize (const label newSize, const label &val)
 Alias for resize(const label, const T&) More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const label &val)
 Append an element at the end of the list. More...
 
void append (label &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< label > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< label, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
void transfer (List< label > &list)
 
void transfer (DynamicList< label, SizeMin > &list)
 
void transfer (SortableList< label > &list)
 
label & newElmt (const label i)
 
void operator= (const UList< label > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< label > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< label > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< label, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< label, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< label > list)
 Assignment to an initializer list. More...
 
void operator= (const label &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< label > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< label, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SortableList< label > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< label > &&list)
 Move assignment. Takes constant time. More...
 
void shallowCopy (const UList< label > &)=delete
 No shallowCopy permitted. More...
 
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...
 
- 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, with index zero. 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 &p, const label index)
 Copy construct, resetting the index. More...
 
const wordname () const
 The patch name. More...
 
wordname ()
 Modifiable patch name. More...
 
const wordphysicalType () const
 The (optional) physical type of the patch. More...
 
wordphysicalType ()
 Modifiable (optional) physical type of the patch. More...
 
label index () const
 The index of this patch in the boundaryMesh. More...
 
label & index ()
 Modifiable index of this patch in the boundaryMesh. More...
 
const wordListinGroups () const
 The (optional) groups that the patch belongs to. More...
 
wordListinGroups ()
 Modifiable (optional) groups that the patch belongs to. More...
 
bool inGroup (const word &name) const
 True if the patch is in named group. More...
 
void write (Ostream &os) const
 

Protected Member Functions

virtual void makeCorrVecs (vectorField &) const
 Make patch face non-orthogonality correction vectors. 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...
 

Additional Inherited Members

- Public Types inherited from faPatch
typedef faBoundaryMesh BoundaryMesh
 
- Public Types inherited from List< label >
typedef SubList< label > subList
 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 List< label >
static const List< label > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from patchIdentifier
static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN". More...
 

Detailed Description

Symmetry-plane patch.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 56 of file symmetryFaPatch.H.

Constructor & Destructor Documentation

◆ symmetryFaPatch() [1/2]

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

Construct from components.

Definition at line 51 of file symmetryFaPatch.C.

◆ symmetryFaPatch() [2/2]

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

Construct from dictionary.

Definition at line 64 of file symmetryFaPatch.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::name().

Here is the call graph for this function:

◆ ~symmetryFaPatch()

virtual ~symmetryFaPatch ( )
virtualdefault

Destructor.

Member Function Documentation

◆ makeCorrVecs()

void makeCorrVecs ( vectorField cv) const
protectedvirtual

Make patch face non-orthogonality correction vectors.

Definition at line 41 of file symmetryFaPatch.C.

References VectorSpace< Vector< Cmpt >, Cmpt, 3 >::zero.

◆ TypeName()

TypeName ( symmetryPolyPatch::typeName_()  )

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 99 of file symmetryFaPatch.H.

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

Here is the call graph for this function:

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