Base class for Lagrangian boundary conditions. More...

Inheritance diagram for LagrangianPatchField< Type >:

[legend]

Collaboration diagram for LagrangianPatchField< Type >:

Public Types
typedef LagrangianPatch	Patch
	The patch type. More...

typedef calculatedLagrangianPatchField< Type >	Calculated
	The calculated patch field type. More...

Public Member Functions
	TypeName ("LagrangianPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, LagrangianPatchField, LagrangianPatch,(const LagrangianPatch &p, const regIOobject &iIo),(p, iIo))
	Select given patch and internal field. More...

	declareRunTimeSelectionTable (autoPtr, LagrangianPatchField, dictionary,(const LagrangianPatch &p, const regIOobject &iIo, const dictionary &dict),(p, iIo, dict))
	Select given patch, internal field and dictionary. More...

	LagrangianPatchField (const LagrangianPatch &, const regIOobject &)
	Construct from patch and internal field. More...

	LagrangianPatchField (const LagrangianPatch &, const regIOobject &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	LagrangianPatchField (const LagrangianPatchField< Type > &)
	Construct as copy. More...

	LagrangianPatchField (const LagrangianPatchField< Type > &, const regIOobject &)
	Construct as copy setting the internal field reference. More...

	LagrangianPatchField (const LagrangianPatchField< Type > &, const LagrangianPatch &, const regIOobject &)
	Construct as copy setting the patch and the internal field reference. More...

virtual autoPtr< LagrangianPatchField< Type > >	clone () const =0
	Construct and return a clone. More...

virtual autoPtr< LagrangianPatchField< Type > >	clone (const regIOobject &) const =0
	Construct and return a clone setting the internal field reference. More...

virtual autoPtr< LagrangianPatchField< Type > >	clone (const LagrangianPatch &, const regIOobject &) const
	Construct and return a clone onto a new patch. More...

virtual	~LagrangianPatchField ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const LagrangianPatch &	patch () const
	Return patch. More...

const dimensionSet &	internalDimensions () const
	Return internal dimensions reference. More...

const LagrangianInternalDynamicField< Type > &	internalField () const
	Return internal field reference. More...

tmp< LagrangianSubSubField< Type > >	internalSubField () const
	Generate an internal sub field corresponding to this patch. More...

SubField< Type >	primitiveSubField () const
	Generate a primitive sub field corresponding to this patch. More...

virtual void	reset (const LagrangianPatchField< Type > &)
	Reset to the given LagrangianPatchField. More...

virtual void	initEvaluate (PstreamBuffers &, const LagrangianScalarInternalDynamicField &fraction)
	Initialise evaluation of the patch field. More...

virtual void	evaluate (PstreamBuffers &, const LagrangianScalarInternalDynamicField &fraction)
	Evaluate the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

tmp< LagrangianSubSubField< Type > >	operator() () const
	Generate a sub-sub field corresponding to this patch. More...

virtual void	operator= (const LagrangianPatchField< Type > &)

virtual void	operator= (const LagrangianSubField< Type > &)

virtual void	operator= (const LagrangianSubSubField< Type > &)

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const Type &)

virtual void	operator== (const LagrangianPatchField< Type > &)

virtual void	operator== (const LagrangianSubField< Type > &)

virtual void	operator== (const LagrangianSubSubField< Type > &)

virtual void	operator== (const UList< Type > &)

virtual void	operator== (const Type &)

virtual void	operator+= (const LagrangianPatchField< Type > &)

virtual void	operator+= (const LagrangianSubField< Type > &)

virtual void	operator+= (const LagrangianSubSubField< Type > &)

virtual void	operator+= (const UList< Type > &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const LagrangianPatchField< Type > &)

virtual void	operator-= (const LagrangianSubField< Type > &)

virtual void	operator-= (const LagrangianSubSubField< Type > &)

virtual void	operator-= (const UList< Type > &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const LagrangianPatchField< scalar > &)

virtual void	operator*= (const LagrangianSubField< scalar > &)

virtual void	operator*= (const LagrangianSubSubField< scalar > &)

virtual void	operator*= (const UList< scalar > &)

virtual void	operator*= (const scalar &)

virtual void	operator/= (const LagrangianPatchField< scalar > &)

virtual void	operator/= (const LagrangianSubField< scalar > &)

virtual void	operator/= (const LagrangianSubSubField< scalar > &)

virtual void	operator/= (const UList< scalar > &)

virtual void	operator/= (const scalar &)

template<class Type2 >
Foam::autoPtr< Foam::LagrangianPatchField< Type > >	NewCalculatedType (const LagrangianPatchField< Type2 > &pf)

Static Public Member Functions
static autoPtr< LagrangianPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const LagrangianPatch &p, const regIOobject &)
	Return a pointer to a new LagrangianPatchField with a given type. More...

static autoPtr< LagrangianPatchField< Type > >	New (const word &, const LagrangianPatch &, const regIOobject &)
	Return a pointer to a new LagrangianPatchField with a given type. More...

static autoPtr< LagrangianPatchField< Type > >	New (const LagrangianPatch &, const regIOobject &, const dictionary &)
	Return a pointer to a new LagrangianPatchField corresponding to a. More...

template<class Type2 >
static autoPtr< LagrangianPatchField< Type > >	NewCalculatedType (const LagrangianPatchField< Type2 > &)
	Return a pointer to a new calculatedPointPatchField. More...

static const word &	calculatedType ()
	Return the type of the calculated form of LagrangianPatchField. More...

Static Public Attributes
static int	disallowGenericLagrangianPatchField
	Debug switch to disallow the use of genericLagrangianPatchField. More...

Protected Attributes
const regIOobject &	internalIo_
	Reference to the internal IO object. More...

const LagrangianInternalDynamicField< Type > &	internalField_
	Reference to the internal field. More...

const LagrangianInternalField< Type > &	internalNonDynamicField_
	Reference to the non-dynamic internal field. More...

Friends
template<class Type2 >
class	LagrangianPatchField
	Declare friendship with patch fields of different types. More...

Ostream &	operator (Ostream &, const LagrangianPatchField< Type > &)
	Ostream operator. More...

Detailed Description

template<class Type>
class Foam::LagrangianPatchField< Type >

Base class for Lagrangian boundary conditions.

Source files

Definition at line 67 of file LagrangianPatchField.H.

Member Typedef Documentation

◆ Patch

typedef LagrangianPatch Patch

The patch type.

Definition at line 99 of file LagrangianPatchField.H.

◆ Calculated

typedef calculatedLagrangianPatchField<Type> Calculated

The calculated patch field type.

Definition at line 102 of file LagrangianPatchField.H.

Constructor & Destructor Documentation

◆ LagrangianPatchField() [1/5]

LagrangianPatchField	(	const LagrangianPatch &	p,
		const regIOobject &	iIo
	)

Construct from patch and internal field.

Definition at line 35 of file LagrangianPatchField.C.

◆ LagrangianPatchField() [2/5]

LagrangianPatchField	(	const LagrangianPatch &	p,
		const regIOobject &	iIo,
		const dictionary &
	)

Construct from patch, internal field and dictionary.

Definition at line 55 of file LagrangianPatchField.C.

◆ LagrangianPatchField() [3/5]

LagrangianPatchField ( const LagrangianPatchField< Type > & ptf )

Construct as copy.

Definition at line 76 of file LagrangianPatchField.C.

◆ LagrangianPatchField() [4/5]

LagrangianPatchField	(	const LagrangianPatchField< Type > &	ptf,
		const regIOobject &	iIo
	)

Construct as copy setting the internal field reference.

Definition at line 89 of file LagrangianPatchField.C.

◆ LagrangianPatchField() [5/5]

LagrangianPatchField	(	const LagrangianPatchField< Type > &	ptf,
		const LagrangianPatch &	p,
		const regIOobject &	iIo
	)

Construct as copy setting the patch and the internal field reference.

Definition at line 109 of file LagrangianPatchField.C.

◆ ~LagrangianPatchField()

~LagrangianPatchField

virtual

Destructor.

Definition at line 266 of file LagrangianPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LagrangianPatchField< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		LagrangianPatchField< Type >	,
		LagrangianPatch	,
		(const LagrangianPatch &p, const regIOobject &iIo)	,
		(p, iIo)
	)

Select given patch and internal field.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		LagrangianPatchField< Type >	,
		dictionary	,
		(const LagrangianPatch &p, const regIOobject &iIo, const dictionary &dict)	,
		(p, iIo, dict)
	)

Select given patch, internal field and dictionary.

◆ clone() [1/3]

virtual autoPtr<LagrangianPatchField<Type> > clone ( ) const

pure virtual

Construct and return a clone.

◆ clone() [2/3]

virtual autoPtr<LagrangianPatchField<Type> > clone ( const regIOobject & ) const

pure virtual

Construct and return a clone setting the internal field reference.

References NotImplemented.

◆ clone() [3/3]

virtual autoPtr<LagrangianPatchField<Type> > clone	(	const LagrangianPatch &	,
		const regIOobject &
	)		const

inlinevirtual

Construct and return a clone onto a new patch.

and setting the internal field reference

Reimplemented in processorCyclicLagrangianPatchField< Type >, processorLagrangianPatchField< Type >, and nonConformalProcessorCyclicLagrangianPatchField< Type >.

Definition at line 189 of file LagrangianPatchField.H.

◆ New() [1/3]

Foam::autoPtr< Foam::LagrangianPatchField< Type > > New	(	const word &	patchFieldType,
		const word &	actualPatchType,
		const LagrangianPatch &	p,
		const regIOobject &	iIo
	)

static

Return a pointer to a new LagrangianPatchField with a given type.

name, corresponding to a LagrangianPatch and internal field

Definition at line 133 of file LagrangianPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, Foam::nl, word::null, p, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [2/3]

Foam::autoPtr< Foam::LagrangianPatchField< Type > > New	(	const word &	patchFieldType,
		const LagrangianPatch &	p,
		const regIOobject &	iIo
	)

static

Return a pointer to a new LagrangianPatchField with a given type.

name, corresponding to a LagrangianPatch and internal field

Definition at line 186 of file LagrangianPatchField.C.

References Foam::New(), word::null, p, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::LagrangianPatchField< Type > > New	(	const LagrangianPatch &	p,
		const regIOobject &	iIo,
		const dictionary &	dict
	)

static

Return a pointer to a new LagrangianPatchField corresponding to a.

LagrangianPatch and internal field, with type and parameters specified in a dictionary

Definition at line 199 of file LagrangianPatchField.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), InfoInFunction, dictionary::lookup(), Foam::nl, p, and Foam::patchFieldType().

Here is the call graph for this function:

◆ NewCalculatedType() [1/2]

static autoPtr<LagrangianPatchField<Type> > NewCalculatedType ( const LagrangianPatchField< Type2 > & )

static

Return a pointer to a new calculatedPointPatchField.

◆ db()

const Foam::objectRegistry & db

Return local objectRegistry.

Definition at line 273 of file LagrangianPatchField.C.

◆ patch()

const Foam::LagrangianPatch & patch

Return patch.

Definition at line 280 of file LagrangianPatchField.C.

Referenced by LagrangianPatchField< Type >::NewCalculatedType().

Here is the caller graph for this function:

◆ internalDimensions()

const Foam::dimensionSet & internalDimensions

Return internal dimensions reference.

Definition at line 288 of file LagrangianPatchField.C.

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

Here is the call graph for this function:

◆ internalField()

const Foam::LagrangianInternalDynamicField< Type > & internalField

Return internal field reference.

Definition at line 311 of file LagrangianPatchField.C.

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

Here is the call graph for this function:

◆ internalSubField()

Foam::tmp< Foam::LagrangianSubSubField< Type > > internalSubField

Generate an internal sub field corresponding to this patch.

Definition at line 329 of file LagrangianPatchField.C.

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

Here is the call graph for this function:

◆ primitiveSubField()

Foam::SubField< Type > primitiveSubField

Generate a primitive sub field corresponding to this patch.

Definition at line 351 of file LagrangianPatchField.C.

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

Here is the call graph for this function:

◆ calculatedType()

const Foam::word & calculatedType

static

Return the type of the calculated form of LagrangianPatchField.

Definition at line 31 of file calculatedLagrangianPatchField.C.

◆ reset()

void reset ( const LagrangianPatchField< Type > & )

virtual

Reset to the given LagrangianPatchField.

Definition at line 373 of file LagrangianPatchField.C.

◆ initEvaluate()

void initEvaluate	(	PstreamBuffers &	,
		const LagrangianScalarInternalDynamicField &	fraction
	)

virtual

Initialise evaluation of the patch field.

Reimplemented in processorLagrangianPatchField< Type >.

Definition at line 378 of file LagrangianPatchField.C.

◆ evaluate()

void evaluate	(	PstreamBuffers &	,
		const LagrangianScalarInternalDynamicField &	fraction
	)

virtual

Evaluate the patch field.

Reimplemented in wedgeLagrangianPatchField< Type >, symmetryPlaneLagrangianPatchField< Type >, symmetryLagrangianPatchField< Type >, processorCyclicLagrangianPatchField< Type >, processorLagrangianPatchField< Type >, nonConformalCyclicLagrangianPatchField< Type >, emptyLagrangianPatchField< Type >, and cyclicLagrangianPatchField< Type >.

Definition at line 387 of file LagrangianPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in genericLagrangianPatchField< Type >.

Definition at line 396 of file LagrangianPatchField.C.

References Foam::type(), and Foam::writeEntry().

Here is the call graph for this function:

◆ operator()()

Foam::tmp< Foam::LagrangianSubSubField< Type > > operator()

Generate a sub-sub field corresponding to this patch.

Definition at line 406 of file LagrangianPatchField.C.

◆ operator=() [1/5]

void operator= ( const LagrangianPatchField< Type > & ptf )

virtual

Definition at line 484 of file LagrangianPatchField.C.

◆ operator=() [2/5]

void operator= ( const LagrangianSubField< Type > & sf )

virtual

Definition at line 484 of file LagrangianPatchField.C.

◆ operator=() [3/5]

void operator= ( const LagrangianSubSubField< Type > & ssf )

virtual

Definition at line 484 of file LagrangianPatchField.C.

◆ operator=() [4/5]

void operator= ( const UList< Type > & f )

virtual

Definition at line 484 of file LagrangianPatchField.C.

◆ operator=() [5/5]

void operator= ( const Type & t )

virtual

Definition at line 484 of file LagrangianPatchField.C.

◆ operator==() [1/5]

void operator== ( const LagrangianPatchField< Type > & ptf )

virtual

Definition at line 485 of file LagrangianPatchField.C.

◆ operator==() [2/5]

void operator== ( const LagrangianSubField< Type > & sf )

virtual

Definition at line 485 of file LagrangianPatchField.C.

◆ operator==() [3/5]

void operator== ( const LagrangianSubSubField< Type > & ssf )

virtual

Definition at line 485 of file LagrangianPatchField.C.

◆ operator==() [4/5]

void operator== ( const UList< Type > & f )

virtual

Definition at line 485 of file LagrangianPatchField.C.

◆ operator==() [5/5]

void operator== ( const Type & t )

virtual

Definition at line 485 of file LagrangianPatchField.C.

◆ operator+=() [1/5]

void operator+= ( const LagrangianPatchField< Type > & ptf )

virtual

Definition at line 486 of file LagrangianPatchField.C.

◆ operator+=() [2/5]

void operator+= ( const LagrangianSubField< Type > & sf )

virtual

Definition at line 486 of file LagrangianPatchField.C.

◆ operator+=() [3/5]

void operator+= ( const LagrangianSubSubField< Type > & ssf )

virtual

Definition at line 486 of file LagrangianPatchField.C.

◆ operator+=() [4/5]

void operator+= ( const UList< Type > & f )

virtual

Definition at line 486 of file LagrangianPatchField.C.

◆ operator+=() [5/5]

void operator+= ( const Type & t )

virtual

Definition at line 486 of file LagrangianPatchField.C.

◆ operator-=() [1/5]

void operator-= ( const LagrangianPatchField< Type > & ptf )

virtual

Definition at line 487 of file LagrangianPatchField.C.

◆ operator-=() [2/5]

void operator-= ( const LagrangianSubField< Type > & sf )

virtual

Definition at line 487 of file LagrangianPatchField.C.

◆ operator-=() [3/5]

void operator-= ( const LagrangianSubSubField< Type > & ssf )

virtual

Definition at line 487 of file LagrangianPatchField.C.

◆ operator-=() [4/5]

void operator-= ( const UList< Type > & f )

virtual

Definition at line 487 of file LagrangianPatchField.C.

◆ operator-=() [5/5]

void operator-= ( const Type & t )

virtual

Definition at line 487 of file LagrangianPatchField.C.

◆ operator*=() [1/5]

void operator*= ( const LagrangianPatchField< scalar > & ptf )

virtual

Definition at line 488 of file LagrangianPatchField.C.

◆ operator*=() [2/5]

void operator*= ( const LagrangianSubField< scalar > & sf )

virtual

Definition at line 488 of file LagrangianPatchField.C.

◆ operator*=() [3/5]

void operator*= ( const LagrangianSubSubField< scalar > & ssf )

virtual

Definition at line 488 of file LagrangianPatchField.C.

◆ operator*=() [4/5]

void operator*= ( const UList< scalar > & f )

virtual

Definition at line 488 of file LagrangianPatchField.C.

◆ operator*=() [5/5]

void operator*= ( const scalar & t )

virtual

Definition at line 488 of file LagrangianPatchField.C.

◆ operator/=() [1/5]

void operator/= ( const LagrangianPatchField< scalar > & ptf )

virtual

Definition at line 489 of file LagrangianPatchField.C.

◆ operator/=() [2/5]

void operator/= ( const LagrangianSubField< scalar > & sf )

virtual

Definition at line 489 of file LagrangianPatchField.C.

◆ operator/=() [3/5]

void operator/= ( const LagrangianSubSubField< scalar > & ssf )

virtual

Definition at line 489 of file LagrangianPatchField.C.

◆ operator/=() [4/5]

void operator/= ( const UList< scalar > & f )

virtual

Definition at line 489 of file LagrangianPatchField.C.

◆ operator/=() [5/5]

void operator/= ( const scalar & t )

virtual

Definition at line 489 of file LagrangianPatchField.C.

◆ NewCalculatedType() [2/2]

Foam::autoPtr<Foam::LagrangianPatchField<Type> > NewCalculatedType ( const LagrangianPatchField< Type2 > & pf )

Definition at line 88 of file calculatedLagrangianPatchField.C.

References Field< Type >::null(), and LagrangianPatchField< Type >::patch().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ LagrangianPatchField

friend class LagrangianPatchField

friend

Declare friendship with patch fields of different types.

Definition at line 93 of file LagrangianPatchField.H.

◆ operator

Ostream& operator	(	Ostream &	,
		const LagrangianPatchField< Type > &
	)

friend

Ostream operator.

Member Data Documentation

◆ internalIo_

const regIOobject& internalIo_

protected

Reference to the internal IO object.

Definition at line 80 of file LagrangianPatchField.H.

◆ internalField_

const LagrangianInternalDynamicField<Type>& internalField_

protected

Reference to the internal field.

Definition at line 83 of file LagrangianPatchField.H.

◆ internalNonDynamicField_

const LagrangianInternalField<Type>& internalNonDynamicField_

protected

Reference to the non-dynamic internal field.

Definition at line 86 of file LagrangianPatchField.H.

◆ disallowGenericLagrangianPatchField

int disallowGenericLagrangianPatchField

static

Debug switch to disallow the use of genericLagrangianPatchField.

Definition at line 110 of file LagrangianPatchField.H.

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

src/Lagrangian/Lagrangian/fields/LagrangianFields/LagrangianFieldsFwd.H
src/Lagrangian/Lagrangian/fields/LagrangianPatchFields/LagrangianPatchField/LagrangianPatchField.H
src/Lagrangian/Lagrangian/fields/LagrangianPatchFields/basic/calculated/calculatedLagrangianPatchField.C
src/Lagrangian/Lagrangian/fields/LagrangianPatchFields/LagrangianPatchField/LagrangianPatchField.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<class Type> class Foam::LagrangianPatchField< Type >

Member Typedef Documentation

◆ Patch

◆ Calculated

Constructor & Destructor Documentation

◆ LagrangianPatchField() [1/5]

◆ LagrangianPatchField() [2/5]

◆ LagrangianPatchField() [3/5]

◆ LagrangianPatchField() [4/5]

◆ LagrangianPatchField() [5/5]

◆ ~LagrangianPatchField()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ NewCalculatedType() [1/2]

◆ db()

◆ patch()

◆ internalDimensions()

◆ internalField()

◆ internalSubField()

◆ primitiveSubField()

◆ calculatedType()

◆ reset()

◆ initEvaluate()

◆ evaluate()

◆ write()

◆ operator()()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ operator==() [1/5]

◆ operator==() [2/5]

◆ operator==() [3/5]

◆ operator==() [4/5]

◆ operator==() [5/5]

◆ operator+=() [1/5]

◆ operator+=() [2/5]

◆ operator+=() [3/5]

◆ operator+=() [4/5]

◆ operator+=() [5/5]

◆ operator-=() [1/5]

◆ operator-=() [2/5]

◆ operator-=() [3/5]

◆ operator-=() [4/5]

◆ operator-=() [5/5]

◆ operator*=() [1/5]

◆ operator*=() [2/5]

◆ operator*=() [3/5]

◆ operator*=() [4/5]

◆ operator*=() [5/5]

◆ operator/=() [1/5]

◆ operator/=() [2/5]

◆ operator/=() [3/5]

◆ operator/=() [4/5]

◆ operator/=() [5/5]

◆ NewCalculatedType() [2/2]

Friends And Related Function Documentation

◆ LagrangianPatchField

◆ operator

Member Data Documentation

◆ internalIo_

◆ internalField_

◆ internalNonDynamicField_

◆ disallowGenericLagrangianPatchField

template<class Type>
class Foam::LagrangianPatchField< Type >