Base class for Lagrangian patches. More...

Inheritance diagram for LagrangianPatch:

[legend]

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

	declareRunTimeSelectionTable (autoPtr, LagrangianPatch, polyPatch,(const polyPatch &patch, const LagrangianBoundaryMesh &boundaryMesh),(patch, boundaryMesh))
	Declare run-time constructor selection tables. More...

	LagrangianPatch (const polyPatch &, const LagrangianBoundaryMesh &)
	Construct from a patch and a boundary mesh. More...

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

virtual	~LagrangianPatch ()
	Destructor. More...

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

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

virtual bool	coupled () const
	Return whether or not this patch is coupled. More...

const LagrangianBoundaryMesh &	boundaryMesh () const
	Return the boundary mesh. More...

virtual const LagrangianSubMesh &	mesh () const
	Return the sub-mesh associated with this patch. More...

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

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

virtual void	initEvaluate (PstreamBuffers &, LagrangianMesh &mesh, const LagrangianScalarInternalDynamicField &fraction) const
	Initialise evaluation of changes in elements that have tracked to. More...

virtual void	evaluate (PstreamBuffers &, LagrangianMesh &, const LagrangianScalarInternalDynamicField &fraction) const
	Evaluate changes in elements that have tracked to this patch. More...

virtual void	partition () const
	Update for mesh changes. More...

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

Static Public Member Functions
static autoPtr< LagrangianPatch >	New (const word &type, const polyPatch &patch, const LagrangianBoundaryMesh &boundaryMesh)
	Return a pointer to a new LagrangianPatch of specified type. More...

static autoPtr< LagrangianPatch >	New (const polyPatch &patch, const LagrangianBoundaryMesh &boundaryMesh)
	Return a pointer to a new LagrangianPatch corresponding to the. More...

Detailed Description

Base class for Lagrangian patches.

Source files

Definition at line 53 of file LagrangianPatch.H.

Constructor & Destructor Documentation

◆ LagrangianPatch() [1/2]

LagrangianPatch	(	const polyPatch &	patch,
		const LagrangianBoundaryMesh &	boundaryMesh
	)

Construct from a patch and a boundary mesh.

Definition at line 45 of file LagrangianPatch.C.

◆ LagrangianPatch() [2/2]

LagrangianPatch ( const LagrangianPatch & )

delete

Disallow default bitwise copy construction.

◆ ~LagrangianPatch()

~LagrangianPatch ( )

virtual

Destructor.

Definition at line 95 of file LagrangianPatch.C.

Member Function Documentation

◆ TypeName()

TypeName ( polyPatch::typeName_() )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		LagrangianPatch	,
		polyPatch	,
		(const polyPatch &patch, const LagrangianBoundaryMesh &boundaryMesh)	,
		(patch, boundaryMesh)
	)

Declare run-time constructor selection tables.

◆ New() [1/2]

Foam::autoPtr< Foam::LagrangianPatch > New	(	const word &	type,
		const polyPatch &	patch,
		const LagrangianBoundaryMesh &	boundaryMesh
	)

static

Return a pointer to a new LagrangianPatch of specified type.

corresponding to the given polyPatch

Definition at line 59 of file LagrangianPatch.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Foam::type().

Referenced by LagrangianBoundaryMesh::LagrangianBoundaryMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::LagrangianPatch > New	(	const polyPatch &	patch,
		const LagrangianBoundaryMesh &	boundaryMesh
	)

static

Return a pointer to a new LagrangianPatch corresponding to the.

given polyPatch

Definition at line 83 of file LagrangianPatch.C.

References Foam::New().

Here is the call graph for this function:

◆ patch()

const polyPatch& patch ( ) const

inline

Return the patch.

Definition at line 124 of file LagrangianPatch.H.

Referenced by LagrangianPatch::coupled().

Here is the caller graph for this function:

◆ name()

virtual const word& name ( ) const

inlinevirtual

Return name.

Definition at line 130 of file LagrangianPatch.H.

References patchIdentifier::name().

Referenced by LagrangianPatch::lookupPatchField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return whether or not this patch is coupled.

Definition at line 136 of file LagrangianPatch.H.

References polyPatch::coupled(), and LagrangianPatch::patch().

Here is the call graph for this function:

◆ boundaryMesh()

const LagrangianBoundaryMesh& boundaryMesh ( ) const

inline

Return the boundary mesh.

Definition at line 142 of file LagrangianPatch.H.

Referenced by nonConformalProcessorCyclicLagrangianPatch::referPatch(), and processorCyclicLagrangianPatch::referPatch().

Here is the caller graph for this function:

◆ mesh()

const Foam::LagrangianSubMesh & mesh ( ) const

virtual

Return the sub-mesh associated with this patch.

Reimplemented in wedgeLagrangianPatch, processorLagrangianPatch, nonConformalCyclicLagrangianPatch, and cyclicLagrangianPatch.

Definition at line 101 of file LagrangianPatch.C.

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

Referenced by processorLagrangianPatch::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const

Return the local object registry.

Definition at line 114 of file LagrangianPatch.C.

Referenced by LagrangianPatch::lookupPatchField().

Here is the caller graph for this function:

◆ lookupPatchField()

const GeometricField::Patch & lookupPatchField ( const word & name )

Lookup and return the patchField of the named field from the.

local objectRegistry.

Definition at line 32 of file LagrangianPatchTemplates.C.

References LagrangianPatch::db(), objectRegistry::lookupObject(), and LagrangianPatch::name().

Here is the call graph for this function:

◆ initEvaluate()

void initEvaluate	(	PstreamBuffers &	,
		LagrangianMesh &	mesh,
		const LagrangianScalarInternalDynamicField &	fraction
	)		const

virtual

Initialise evaluation of changes in elements that have tracked to.

this patch

Reimplemented in processorLagrangianPatch, and nonConformalProcessorCyclicLagrangianPatch.

Definition at line 120 of file LagrangianPatch.C.

◆ evaluate()

void evaluate	(	PstreamBuffers &	,
		LagrangianMesh &	mesh,
		const LagrangianScalarInternalDynamicField &	fraction
	)		const

virtual

Evaluate changes in elements that have tracked to this patch.

Reimplemented in wedgeLagrangianPatch, symmetryPlaneLagrangianPatch, symmetryLagrangianPatch, processorLagrangianPatch, nonConformalProcessorCyclicLagrangianPatch, nonConformalCyclicLagrangianPatch, emptyLagrangianPatch, cyclicLagrangianPatch, and cloudVelocityLagrangianPatch.

Definition at line 129 of file LagrangianPatch.C.

References mesh, LagrangianMesh::states(), and Foam::toBeRemoved.

Referenced by cloudVelocityLagrangianPatch::evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ partition()

void partition ( ) const

virtual

Update for mesh changes.

Reimplemented in wedgeLagrangianPatch, processorLagrangianPatch, nonConformalCyclicLagrangianPatch, and cyclicLagrangianPatch.

Definition at line 140 of file LagrangianPatch.C.

References Foam::onPatchZero.

Referenced by cyclicLagrangianPatch::partition(), nonConformalCyclicLagrangianPatch::partition(), processorLagrangianPatch::partition(), and wedgeLagrangianPatch::partition().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const LagrangianPatch & )

delete

Disallow default bitwise assignment.

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

src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianPatches/LagrangianPatch/LagrangianPatch.H
src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianPatches/LagrangianPatch/LagrangianPatch.C
src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianPatches/LagrangianPatch/LagrangianPatchTemplates.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LagrangianPatch() [1/2]

◆ LagrangianPatch() [2/2]

◆ ~LagrangianPatch()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New() [1/2]

◆ New() [2/2]

◆ patch()

◆ name()

◆ coupled()

◆ boundaryMesh()

◆ mesh()

◆ db()

◆ lookupPatchField()

◆ initEvaluate()

◆ evaluate()

◆ partition()

◆ operator=()