Non-conformal cyclic FV patch. As nonConformalCoupledFvPatch, but the neighbouring patch is local and known and is made available by this class. More...

Inheritance diagram for nonConformalCyclicFvPatch:

[legend]

Collaboration diagram for nonConformalCyclicFvPatch:

[legend]

Public Member Functions
	TypeName (nonConformalCyclicPolyPatch::typeName_())
	Runtime type information. More...

	nonConformalCyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch and fvBoundaryMesh. More...

virtual	~nonConformalCyclicFvPatch ()
	Destructor. More...

const nonConformalCyclicPolyPatch &	nonConformalCyclicPatch () const
	Poly patch. More...

const nonConformalCyclicFvPatch &	nbrPatch () const
	Neighbour patch. More...

virtual bool	coupled () const
	Is this patch coupled? Returns true. For NCC patches the poly. More...

virtual label	start () const
	Return the start label of this patch in the polyMesh face list. More...

virtual label	size () const
	Return the size. More...

virtual const labelUList &	faceCells () const
	Return the face-cells. More...

void	makeWeights (scalarField &) const
	Make patch weighting factors. More...

virtual tmp< vectorField >	delta () const
	Return delta (P to N) vectors across coupled patch. More...

virtual bool	owner () const
	Inherit the cyclic owner method. More...

virtual const transformer &	transform () const
	Inherit the cyclic transform method. More...

Public Member Functions inherited from cyclicFvPatch
	TypeName (cyclicPolyPatch::typeName_())
	Runtime type information. More...

	cyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch. More...

const cyclicPolyPatch &	cyclicPatch () const
	Return local reference cast into the cyclic patch. More...

virtual label	nbrPatchIndex () const
	Return neighbour. More...

virtual bool	owner () const
	Does this side own the patch ? More...

virtual const transformer &	transform () const
	Return transformation between the coupled patches. More...

const cyclicFvPatch &	neighbFvPatch () const

virtual tmp< labelField >	interfaceInternalField (const labelUList &internalData) const
	Return the values of the given internal data adjacent to. More...

virtual tmp< labelField >	internalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
	Return neighbour field. More...

Public Member Functions inherited from coupledFvPatch
	TypeName (coupledPolyPatch::typeName_())
	Runtime type information. More...

	coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
	Construct from polyPatch. More...

virtual	~coupledFvPatch ()
	Destructor. More...

virtual bool	neighbour () const
	Does the coupled side own the patch ? More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
	Initialise neighbour field transfer. More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
	Inherit initInternalFieldTransfer from lduInterface. More...

Public Member Functions inherited from lduInterface
	TypeName ("lduInterface")
	Runtime type information. More...

	lduInterface ()
	Construct null. More...

	lduInterface (const lduInterface &)=delete
	Disallow default bitwise copy construction. More...

virtual	~lduInterface ()
	Destructor. More...

virtual void	initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
	Initialise transfer of internal field adjacent to the interface. More...

void	operator= (const lduInterface &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvPatch
	TypeName (polyPatch::typeName_())
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))

	fvPatch (const polyPatch &, const fvBoundaryMesh &)
	Construct from polyPatch and fvBoundaryMesh. More...

	fvPatch (const fvPatch &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvPatch ()
	Destructor. More...

const polyPatch &	patch () const
	Return the polyPatch. More...

virtual const word &	name () const
	Return name. More...

label	index () const
	Return the index of this patch in the fvBoundaryMesh. More...

const fvBoundaryMesh &	boundaryMesh () const
	Return boundaryMesh reference. More...

const objectRegistry &	db () const
	Return the local object registry. More...

template<class T >
const List< T >::subList	patchSlice (const List< T > &l) const
	Slice list to patch. More...

const vectorField &	Cf () const
	Return face centres. More...

tmp< vectorField >	Cn () const
	Return neighbour cell centres. More...

const vectorField &	Sf () const
	Return face area vectors. More...

const scalarField &	magSf () const
	Return face area magnitudes. More...

tmp< vectorField >	nf () const
	Return face normals. More...

tmp< scalarField >	polyFaceFraction () const
	Return the fraction of the poly-face that each fv-face in this. More...

const scalarField &	weights () const
	Return patch weighting factors. More...

virtual const scalarField &	deltaCoeffs () const
	Return the face - cell distance coefficient. 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 >
void	patchInternalField (const UList< Type > &, Field< Type > &) 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 >
GeometricField::Patch &	patchField (GeometricField &) const
	Return the corresponding patchField reference of the named field. More...

template<class GeometricField , class Type >
const GeometricField::Patch &	lookupPatchField (const word &name) const
	Lookup and return the patchField of the named field from the. More...

void	operator= (const fvPatch &)=delete
	Disallow default bitwise assignment. More...

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

Public Member Functions inherited from cyclicLduInterface
	TypeName ("cyclicLduInterface")
	Runtime type information. More...

virtual	~cyclicLduInterface ()
	Destructor. More...

Public Member Functions inherited from nonConformalCoupledFvPatch
	TypeName (nonConformalCoupledPolyPatch::typeName_())
	Runtime type information. More...

	nonConformalCoupledFvPatch (const fvPatch &patch)
	Construct from a patch. More...

virtual	~nonConformalCoupledFvPatch ()
	Destructor. More...

const nonConformalCoupledPolyPatch &	nonConformalCoupledPatch () const
	Return the reference to the polyPatch. More...

bool	owner () const
	Does this side own the patch? More...

bool	neighbour () const
	Does the coupled side own the patch? More...

const transformer &	transform () const
	Return transformation between the coupled patches. More...

const word &	errorPatchName () const
	Error patch name. More...

label	errorPatchIndex () const
	Error patch ID. More...

const nonConformalErrorFvPatch &	errorPatch () const
	Error patch. More...

virtual word	polyFacesType () const
	Return the face-poly-faces patch field type. More...

Public Member Functions inherited from nonConformalFvPatch
	TypeName (nonConformalPolyPatch::typeName_())
	Runtime type information. More...

	nonConformalFvPatch (const fvPatch &patch)
	Construct from a patch. More...

virtual	~nonConformalFvPatch ()
	Destructor. More...

const fvPatch &	patch () const
	Reference to the fvPatch. More...

const nonConformalPolyPatch &	nonConformalPatch () const
	Reference to the polyPatch. More...

const word &	origPatchName () const
	Original patch name. More...

label	origPatchIndex () const
	Original patch ID. More...

const fvPatch &	origPatch () const
	Original patch. More...

const labelList &	polyFaces () const
	Return face face-poly-faces. More...

Additional Inherited Members
Static Public Member Functions inherited from fvPatch
static autoPtr< fvPatch >	New (const polyPatch &, const fvBoundaryMesh &)
	Return a pointer to a new patch created on freestore from polyPatch. More...

static bool	constraintType (const word &pt)
	Return true if the given type is a constraint type. More...

static wordList	constraintTypes ()
	Return a list of all the constraint patch types. More...

Protected Member Functions inherited from coupledFvPatch
void	makeWeights (scalarField &w, const vectorField &nbrSf, const vectorField &nbrDelta) const
	Make patch weighting factors. More...

tmp< vectorField >	delta (const vectorField &nbrDelta) const
	Return delta (P to N) vectors across coupled patch. More...

Protected Member Functions inherited from nonConformalCoupledFvPatch
void	makeWeights (scalarField &w, const vectorField &nbrSf, const vectorField &nbrDelta) const
	Make patch weighting factors. More...

Detailed Description

Non-conformal cyclic FV patch. As nonConformalCoupledFvPatch, but the neighbouring patch is local and known and is made available by this class.

See also: Foam::nonConformalCyclicPolyPatch Foam::nonConformalCoupledFvPatch

Source files

Definition at line 57 of file nonConformalCyclicFvPatch.H.

Constructor & Destructor Documentation

◆ nonConformalCyclicFvPatch()

nonConformalCyclicFvPatch	(	const polyPatch &	patch,
		const fvBoundaryMesh &	bm
	)

Construct from polyPatch and fvBoundaryMesh.

Definition at line 43 of file nonConformalCyclicFvPatch.C.

◆ ~nonConformalCyclicFvPatch()

~nonConformalCyclicFvPatch ( )

virtual

Destructor.

Definition at line 60 of file nonConformalCyclicFvPatch.C.

Member Function Documentation

◆ TypeName()

TypeName ( nonConformalCyclicPolyPatch::typeName_() )

Runtime type information.

◆ nonConformalCyclicPatch()

const Foam::nonConformalCyclicPolyPatch & nonConformalCyclicPatch ( ) const

Poly patch.

Definition at line 67 of file nonConformalCyclicFvPatch.C.

◆ nbrPatch()

const Foam::nonConformalCyclicFvPatch & nbrPatch ( ) const

virtual

Neighbour patch.

Reimplemented from cyclicFvPatch.

Definition at line 74 of file nonConformalCyclicFvPatch.C.

References cyclicFvPatch::nbrPatch().

Here is the call graph for this function:

◆ coupled()

bool coupled ( ) const

virtual

Is this patch coupled? Returns true. For NCC patches the poly.

mesh is considered non-coupled whilst the finite volume mesh is considered coupled.

Reimplemented from coupledFvPatch.

Definition at line 92 of file nonConformalCyclicFvPatch.C.

◆ start()

Foam::label start ( ) const

virtual

Return the start label of this patch in the polyMesh face list.

Raises an error unless the patch is empty.

Reimplemented from nonConformalFvPatch.

Definition at line 80 of file nonConformalCyclicFvPatch.C.

References nonConformalFvPatch::start().

Here is the call graph for this function:

◆ size()

Foam::label size ( ) const

virtual

Return the size.

Reimplemented from nonConformalFvPatch.

Definition at line 86 of file nonConformalCyclicFvPatch.C.

References nonConformalFvPatch::size().

Here is the call graph for this function:

◆ faceCells()

const Foam::labelUList & faceCells ( ) const

virtual

Return the face-cells.

Reimplemented from coupledFvPatch.

Definition at line 98 of file nonConformalCyclicFvPatch.C.

References nonConformalFvPatch::faceCells().

Here is the call graph for this function:

◆ makeWeights()

void makeWeights ( scalarField & w ) const

virtual

Make patch weighting factors.

Reimplemented from cyclicFvPatch.

Definition at line 104 of file nonConformalCyclicFvPatch.C.

References coupledFvPatch::delta(), and nonConformalCoupledFvPatch::makeWeights().

Here is the call graph for this function:

◆ delta()

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

virtual

Return delta (P to N) vectors across coupled patch.

Reimplemented from cyclicFvPatch.

Definition at line 116 of file nonConformalCyclicFvPatch.C.

References coupledFvPatch::delta().

Here is the call graph for this function:

◆ owner()

virtual bool owner

inline

Inherit the cyclic owner method.

Definition at line 101 of file cyclicFvPatch.H.

◆ transform()

virtual const transformer& transform

inline

Inherit the cyclic transform method.

Definition at line 116 of file cyclicFvPatch.H.

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

src/finiteVolume/fvMesh/fvPatches/constraint/nonConformalCyclic/nonConformalCyclicFvPatch.H
src/finiteVolume/fvMesh/fvPatches/constraint/nonConformalCyclic/nonConformalCyclicFvPatch.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nonConformalCyclicFvPatch()

◆ ~nonConformalCyclicFvPatch()

Member Function Documentation

◆ TypeName()

◆ nonConformalCyclicPatch()

◆ nbrPatch()

◆ coupled()

◆ start()

◆ size()

◆ faceCells()

◆ makeWeights()

◆ delta()

◆ owner()

◆ transform()