This BC provides a clamped BC. It sets zero fixe value and zeroGradient. More...

Inheritance diagram for clampedPlateFaPatchField< Type >:

Collaboration diagram for clampedPlateFaPatchField< Type >:

Public Member Functions
	TypeName ("clampedPlate")

	clampedPlateFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)

	clampedPlateFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

	clampedPlateFaPatchField (const clampedPlateFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

	clampedPlateFaPatchField (const clampedPlateFaPatchField< Type > &)

virtual tmp< faPatchField< Type > >	clone () const

	clampedPlateFaPatchField (const clampedPlateFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)

virtual tmp< faPatchField< Type > >	clone (const DimensionedField< Type, areaMesh > &iF) const

virtual	~clampedPlateFaPatchField ()

virtual tmp< Field< Type > >	snGrad () const

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	write (Ostream &) const

void	evaluate (const Pstream::commsTypes)

Public Member Functions inherited from faPatchField< Type >
	TypeName ("faPatchField")

	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

	faPatchField (const faPatchField< Type > &)

	faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)

virtual tmp< faPatchField< Type > >	clone () const

Foam::tmp< Foam::faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &pf)

virtual	~faPatchField ()=default

const objectRegistry &	db () const

const faPatch &	patch () const

const DimensionedField< Type, areaMesh > &	internalField () const

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

virtual bool	fixesValue () const

virtual bool	coupled () const

bool	updated () const

virtual void	autoMap (const faPatchFieldMapper &)

virtual void	rmap (const faPatchField< Type > &, const labelList &)

virtual tmp< Field< Type > >	snGrad () const

virtual void	updateCoeffs ()

virtual tmp< Field< Type > >	patchInternalField () const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

void	check (const faPatchField< Type > &) const

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

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

virtual void	operator= (const Type &)

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

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

virtual void	operator+= (const Type &)

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

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

virtual void	operator-= (const Type &)

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

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

virtual void	operator*= (const scalar)

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

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

virtual void	operator/= (const scalar)

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

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

virtual void	operator== (const Type &)

Additional Inherited Members
Public Types inherited from faPatchField< Type >
typedef faPatch	Patch

typedef calculatedFaPatchField< Type >	Calculated

Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)

static const word &	calculatedType ()

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField

Detailed Description

template<class Type>
class Foam::clampedPlateFaPatchField< Type >

This BC provides a clamped BC. It sets zero fixe value and zeroGradient.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type                clampedPlate;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: clampedPlate	word	yes	-

The inherited entries are elaborated in:

faPatchFields.H

Source files

Definition at line 81 of file clampedPlateFaPatchField.H.

Constructor & Destructor Documentation

◆ clampedPlateFaPatchField() [1/5]

clampedPlateFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF
	)

Definition at line 35 of file clampedPlateFaPatchField.C.

◆ clampedPlateFaPatchField() [2/5]

clampedPlateFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 46 of file clampedPlateFaPatchField.C.

References faPatchField::operator=().

Here is the call graph for this function:

◆ clampedPlateFaPatchField() [3/5]

clampedPlateFaPatchField	(	const clampedPlateFaPatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Definition at line 60 of file clampedPlateFaPatchField.C.

◆ clampedPlateFaPatchField() [4/5]

clampedPlateFaPatchField ( const clampedPlateFaPatchField< Type > & ptf )

Definition at line 73 of file clampedPlateFaPatchField.C.

◆ clampedPlateFaPatchField() [5/5]

clampedPlateFaPatchField	(	const clampedPlateFaPatchField< Type > &	ptf,
		const DimensionedField< Type, areaMesh > &	iF
	)

Definition at line 83 of file clampedPlateFaPatchField.C.

◆ ~clampedPlateFaPatchField()

virtual ~clampedPlateFaPatchField ( )

inlinevirtual

Definition at line 154 of file clampedPlateFaPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "clampedPlate" )

◆ clone() [1/2]

virtual tmp<faPatchField<Type> > clone ( ) const

inlinevirtual

Definition at line 125 of file clampedPlateFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > & iF ) const

inlinevirtual

Reimplemented from faPatchField< Type >.

Definition at line 142 of file clampedPlateFaPatchField.H.

◆ snGrad()

virtual tmp<Field<Type> > snGrad ( ) const

inlinevirtual

Definition at line 163 of file clampedPlateFaPatchField.H.

References Foam::Zero.

◆ evaluate() [1/2]

void evaluate ( const Pstream::commsTypes commsType = Pstream::commsTypes::blocking )

virtual

Reimplemented from faPatchField< Type >.

Definition at line 95 of file clampedPlateFaPatchField.C.

References notImplemented, and Foam::type().

Here is the call graph for this function:

◆ valueInternalCoeffs()

tmp< Field< Type > > valueInternalCoeffs ( const tmp< scalarField > & ) const

virtual

Definition at line 125 of file clampedPlateFaPatchField.C.

◆ valueBoundaryCoeffs()

tmp< Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > & ) const

virtual

Definition at line 136 of file clampedPlateFaPatchField.C.

◆ gradientInternalCoeffs()

tmp< Field< Type > > gradientInternalCoeffs

virtual

Definition at line 146 of file clampedPlateFaPatchField.C.

References Foam::foamVersion::patch.

◆ gradientBoundaryCoeffs()

tmp< Field< Type > > gradientBoundaryCoeffs

virtual

Definition at line 154 of file clampedPlateFaPatchField.C.

References Foam::foamVersion::patch.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from faPatchField< Type >.

Definition at line 161 of file clampedPlateFaPatchField.C.

References os(), and faPatchField::write().

Here is the call graph for this function:

◆ evaluate() [2/2]

void evaluate ( const Pstream::commsTypes )

virtual

Reimplemented from faPatchField< Type >.

Definition at line 102 of file clampedPlateFaPatchField.C.

References edgeID, faPatchField::evaluate(), forAll, Field::operator=(), and Foam::foamVersion::patch.

Here is the call graph for this function:

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

src/finiteArea/fields/faPatchFields/derived/clampedPlate/clampedPlateFaPatchField.H
src/finiteArea/fields/faPatchFields/derived/clampedPlate/clampedPlateFaPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::clampedPlateFaPatchField< Type >

Constructor & Destructor Documentation

◆ clampedPlateFaPatchField() [1/5]

◆ clampedPlateFaPatchField() [2/5]

◆ clampedPlateFaPatchField() [3/5]

◆ clampedPlateFaPatchField() [4/5]

◆ clampedPlateFaPatchField() [5/5]

◆ ~clampedPlateFaPatchField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ snGrad()

◆ evaluate() [1/2]

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

◆ write()

◆ evaluate() [2/2]

template<class Type>
class Foam::clampedPlateFaPatchField< Type >