Cyclic-plane patch. More...

Inheritance diagram for cyclicFaPatch:

Collaboration diagram for cyclicFaPatch:

Public Member Functions
	TypeName ("cyclic")

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

virtual	~cyclicFaPatch ()=default

virtual bool	master () const

virtual label	neighbPatchID () const

virtual bool	owner () const

virtual const cyclicLduInterface &	neighbPatch () const

virtual const tensorField &	forwardT () const

virtual const tensorField &	reverseT () const

virtual void	initGeometry ()

virtual void	calcGeometry ()

virtual void	initMovePoints (const pointField &)

virtual void	movePoints (const pointField &)

virtual tmp< vectorField >	delta () const

virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData) const

virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData, const labelUList &edgeFaces) const

virtual tmp< labelField >	transfer (const Pstream::commsTypes commsType, const labelUList &interfaceData) const

virtual tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const

virtual tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData, const labelUList &edgeCells) const

Public Member Functions inherited from coupledFaPatch
	TypeName ("coupled")

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

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

virtual	~coupledFaPatch ()=default

virtual bool	coupled () const

bool	separated () const

const vectorField &	separation () const

const tensorField &	forwardT () const

const tensorField &	reverseT () const

bool	parallel () const

virtual const labelUList &	faceCells () const

virtual void	initTransfer (const Pstream::commsTypes commsType, const labelUList &interfaceData) const

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const

Public Member Functions inherited from lduInterface
	TypeName ("lduInterface")

	lduInterface ()=default

virtual	~lduInterface ()=default

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const

Public Member Functions inherited from faPatch
	TypeName ("patch")

	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)

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

	faPatch (const faPatch &, const faBoundaryMesh &)

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

virtual	~faPatch ()

const labelList &	edgeLabels () const noexcept

void	edgeLabels (const UList< label > &newEdgeLabels)

label	nPoints () const

label	nEdges () const noexcept

label	ngbPolyPatchIndex () const noexcept

const faBoundaryMesh &	boundaryMesh () const noexcept

label	start () const

virtual label	size () const

label	whichEdge (const label l) const

template<class T >
List< T >::subList	patchSlice (const List< T > &l) const

virtual void	write (Ostream &) const

List< labelPair >	boundaryConnections () const

labelList	boundaryProcs () const

List< labelPair >	boundaryProcSizes () const

const labelList &	pointLabels () const

const labelListList &	pointEdges () const

tmp< vectorField >	ngbPolyPatchFaceNormals () const

tmp< vectorField >	ngbPolyPatchPointNormals () const

const labelUList &	edgeFaces () const

const vectorField &	edgeCentres () const

const vectorField &	edgeLengths () const

const scalarField &	magEdgeLengths () const

tmp< vectorField >	edgeNormals () const

tmp< vectorField >	edgeFaceCentres () const

const scalarField &	weights () const

void	makeCorrectionVectors (vectorField &) const

const scalarField &	deltaCoeffs () const

void	resetEdges (const UList< label > &newEdges)

void	resetEdges (labelList &&newEdges)

template<class Type >
tmp< Field< Type > >	patchInternalField (const UList< Type > &) const

template<class Type >
tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &f, const labelUList &edgeFaces) const

template<class GeometricField , class Type >
const GeometricField::Patch &	patchField (const GeometricField &) const

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

Public Member Functions inherited from patchIdentifier
	patchIdentifier (const patchIdentifier &)=default

patchIdentifier &	operator= (const patchIdentifier &)=default

virtual	~patchIdentifier ()=default

	patchIdentifier ()

	patchIdentifier (const word &name, const label index)

	patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())

	patchIdentifier (const word &name, const dictionary &dict, const label index)

	patchIdentifier (const patchIdentifier &ident, const label index)

const word &	name () const noexcept

word &	name () noexcept

label	index () const noexcept

label &	index () noexcept

const word &	physicalType () const noexcept

word &	physicalType () noexcept

const wordList &	inGroups () const noexcept

wordList &	inGroups () noexcept

bool	inGroup (const word &name) const

void	write (Ostream &os) const

Public Member Functions inherited from List
constexpr	List () noexcept

	List (const label len)

	List (const label len, const T &val)

	List (const label len, const Foam::zero)

	List (const Foam::one, const T &val)

	List (const Foam::one, T &&val)

	List (const Foam::one, const Foam::zero)

	List (const List< T > &a)

	List (const UList< T > &a)

	List (List< T > &a, bool reuse)

	List (const UList< T > &list, const labelUList &indices)

template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)

template<unsigned N>
	List (const FixedList< T, N > &list)

	List (const PtrList< T > &list)

	List (const SLList< T > &list)

template<class Addr >
	List (const IndirectListBase< T, Addr > &list)

	List (std::initializer_list< T > list)

	List (List< T > &&list)

template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)

	List (SortableList< T > &&list)

	List (SLList< T > &&list)

	List (Istream &is)

autoPtr< List< T > >	clone () const

	~List ()

void	clear ()

void	resize (const label len)

void	resize (const label len, const T &val)

void	resize_nocopy (const label len)

void	setSize (const label n)

void	setSize (const label n, const T &val)

void	append (const T &val)

void	append (T &&val)

void	append (const UList< T > &list)

template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)

label	appendUniq (const T &val)

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)

void	operator= (const List< T > &list)

void	operator= (const SLList< T > &list)

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)

template<unsigned N>
void	operator= (const FixedList< T, N > &list)

void	operator= (std::initializer_list< T > list)

void	operator= (const T &val)

void	operator= (const Foam::zero)

void	operator= (List< T > &&list)

template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)

void	operator= (SortableList< T > &&list)

void	operator= (SLList< T > &&list)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< T > &)=delete

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)

template<class T >
	List (const label len)

template<class T >
	List (const label len, const T &val)

template<class T >
	List (const label len, const Foam::zero)

template<class T >
	List (const Foam::one, const T &val)

template<class T >
	List (const Foam::one, T &&val)

template<class T >
	List (const Foam::one, const Foam::zero)

template<class T >
	List (const UList< T > &a)

template<class T >
	List (const List< T > &a)

template<class T >
	List (List< T > &a, bool reuse)

template<class T >
	List (const UList< T > &list, const labelUList &indices)

template<class T >
	List (const PtrList< T > &list)

template<class T >
	List (const SLList< T > &list)

template<class T >
	List (std::initializer_list< T > list)

template<class T >
	List (List< T > &&list)

template<class T >
	List (SortableList< T > &&list)

template<class T >
	List (SLList< T > &&list)

template<class T >
void	transfer (List< T > &list)

template<class T >
void	transfer (SortableList< T > &list)

template<class T >
void	operator= (const UList< T > &a)

template<class T >
void	operator= (const List< T > &list)

template<class T >
void	operator= (const SLList< T > &list)

template<class T >
void	operator= (std::initializer_list< T > list)

template<class T >
void	operator= (List< T > &&list)

template<class T >
void	operator= (SortableList< T > &&list)

template<class T >
void	operator= (SLList< T > &&list)

Istream &	readList (Istream &is)

template<class T >
constexpr	List () noexcept

void	resize (const label newLen)

template<class T >
void	append (const T &val)

template<class T >
void	append (T &&val)

template<class T >
void	append (const UList< T > &list)

template<class T >
void	operator= (const T &val)

template<class T >
void	operator= (const Foam::zero)

template<class T >
	List (Istream &is)

Istream &	readList (Istream &is)

Public Member Functions inherited from cyclicLduInterface
	TypeName ("cyclicLduInterface")

	cyclicLduInterface ()=default

virtual	~cyclicLduInterface ()=default

Protected Member Functions
void	makeWeights (scalarField &) const

void	makeDeltaCoeffs (scalarField &) const

Protected Member Functions inherited from coupledFaPatch
void	calcTransformTensors (const vector &Cf, const vector &Cr, const vector &nf, const vector &nr) const

void	calcTransformTensors (const vectorField &Cf, const vectorField &Cr, const vectorField &nf, const vectorField &nr) const

Protected Member Functions inherited from faPatch
void	calcPointLabels () const

void	calcPointEdges () const

virtual void	initUpdateMesh ()

virtual void	updateMesh ()

Static Protected Attributes
static const scalar	matchTol_ = 1e-3

Additional Inherited Members
Public Types inherited from faPatch
typedef faBoundaryMesh	BoundaryMesh

Public Types inherited from List
typedef SubList< T >	subList

Static Public Member Functions inherited from faPatch
static autoPtr< faPatch >	New (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)

Static Public Member Functions inherited from List
static const List< T > &	null ()

Detailed Description

Cyclic-plane patch.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 53 of file cyclicFaPatch.H.

Constructor & Destructor Documentation

◆ cyclicFaPatch()

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

inline

Definition at line 90 of file cyclicFaPatch.H.

◆ ~cyclicFaPatch()

virtual ~cyclicFaPatch ( )

virtualdefault

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField & w ) const

protectedvirtual

Implements coupledFaPatch.

Definition at line 145 of file cyclicFaPatch.C.

References Foam::abort(), faPatch::delta(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), Foam::max(), Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ makeDeltaCoeffs()

void makeDeltaCoeffs ( scalarField & dc ) const

protectedvirtual

Implements coupledFaPatch.

Definition at line 200 of file cyclicFaPatch.C.

References faPatch::delta().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "cyclic" )

◆ master()

virtual bool master ( ) const

inlinevirtual

Definition at line 110 of file cyclicFaPatch.H.

Referenced by cyclicFaPatch::owner().

Here is the caller graph for this function:

◆ neighbPatchID()

virtual label neighbPatchID ( ) const

inlinevirtual

Implements cyclicLduInterface.

Definition at line 116 of file cyclicFaPatch.H.

References patchIdentifier::index(), and NotImplemented.

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const

inlinevirtual

Implements cyclicLduInterface.

Definition at line 122 of file cyclicFaPatch.H.

References cyclicFaPatch::master().

Here is the call graph for this function:

◆ neighbPatch()

virtual const cyclicLduInterface& neighbPatch ( ) const

inlinevirtual

Implements cyclicLduInterface.

Definition at line 128 of file cyclicFaPatch.H.

References NotImplemented.

◆ forwardT()

virtual const tensorField& forwardT ( ) const

inlinevirtual

Implements cyclicLduInterface.

Definition at line 135 of file cyclicFaPatch.H.

References coupledFaPatch::forwardT().

Referenced by cyclicFaPatchField< Type >::forwardT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const

inlinevirtual

Implements cyclicLduInterface.

Definition at line 141 of file cyclicFaPatch.H.

References coupledFaPatch::reverseT().

Referenced by cyclicFaPatchField< Type >::reverseT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initGeometry()

void initGeometry ( )

virtual

Implements coupledFaPatch.

Definition at line 216 of file cyclicFaPatch.C.

References faPatch::initGeometry().

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( )

virtual

Implements coupledFaPatch.

Definition at line 222 of file cyclicFaPatch.C.

References faPatch::calcGeometry().

Here is the call graph for this function:

◆ initMovePoints()

void initMovePoints ( const pointField & p )

virtual

Implements coupledFaPatch.

Definition at line 229 of file cyclicFaPatch.C.

References faPatch::initMovePoints(), and p.

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const pointField & p )

virtual

Implements coupledFaPatch.

Definition at line 235 of file cyclicFaPatch.C.

References faPatch::movePoints(), and p.

Here is the call graph for this function:

◆ delta()

Foam::tmp< Foam::vectorField > delta ( ) const

virtual

Implements coupledFaPatch.

Definition at line 242 of file cyclicFaPatch.C.

References faPatch::delta(), tmp::New(), and Foam::transform().

Here is the call graph for this function:

◆ interfaceInternalField() [1/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList & internalData ) const

virtual

Implements coupledFaPatch.

Definition at line 279 of file cyclicFaPatch.C.

◆ interfaceInternalField() [2/2]

Foam::tmp< Foam::labelField > interfaceInternalField	(	const labelUList &	internalData,
		const labelUList &	edgeFaces
	)		const

virtual

Implements lduInterface.

Definition at line 288 of file cyclicFaPatch.C.

◆ transfer()

Foam::tmp< Foam::labelField > transfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	interfaceData
	)		const

virtual

Implements coupledFaPatch.

Definition at line 298 of file cyclicFaPatch.C.

References tmp::New().

Here is the call graph for this function:

◆ internalFieldTransfer() [1/2]

Foam::tmp< Foam::labelField > internalFieldTransfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	internalData
	)		const

virtual

Implements coupledFaPatch.

Definition at line 319 of file cyclicFaPatch.C.

◆ internalFieldTransfer() [2/2]

Foam::tmp< Foam::labelField > internalFieldTransfer	(	const Pstream::commsTypes	commsType,
		const labelUList &	internalData,
		const labelUList &	edgeCells
	)		const

virtual

Definition at line 329 of file cyclicFaPatch.C.

References tmp::New().

Here is the call graph for this function:

Member Data Documentation

◆ matchTol_

const Foam::scalar matchTol_ = 1e-3

staticprotected

Definition at line 68 of file cyclicFaPatch.H.

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

src/finiteArea/faMesh/faPatches/constraint/cyclic/cyclicFaPatch.H
src/finiteArea/faMesh/faPatches/constraint/cyclic/cyclicFaPatch.C

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cyclicFaPatch()

◆ ~cyclicFaPatch()

Member Function Documentation

◆ makeWeights()

◆ makeDeltaCoeffs()

◆ TypeName()

◆ master()

◆ neighbPatchID()

◆ owner()

◆ neighbPatch()

◆ forwardT()

◆ reverseT()

◆ initGeometry()

◆ calcGeometry()

◆ initMovePoints()

◆ movePoints()

◆ delta()

◆ interfaceInternalField() [1/2]

◆ interfaceInternalField() [2/2]

◆ transfer()

◆ internalFieldTransfer() [1/2]

◆ internalFieldTransfer() [2/2]

Member Data Documentation

◆ matchTol_