Enables the specification of a uniform fixed value boundary condition. More...

Inheritance diagram for uniformFixedValuePointPatchField< Type >:

Collaboration diagram for uniformFixedValuePointPatchField< Type >:

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

	uniformFixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	uniformFixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	uniformFixedValuePointPatchField (const uniformFixedValuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

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

virtual autoPtr< pointPatchField< Type > >	clone () const
	Construct and return a clone. More...

	uniformFixedValuePointPatchField (const uniformFixedValuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const DataEntry< Type > &	uniformValue () const
	Return the uniform value. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

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

Public Member Functions inherited from fixedValuePointPatchField< Type >
	TypeName ("fixedValue")
	Runtime type information. More...

	fixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	fixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fixedValuePointPatchField (const fixedValuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

	fixedValuePointPatchField (const fixedValuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

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

virtual void	operator= (const Type &)

Public Member Functions inherited from valuePointPatchField< Type >
	TypeName ("value")
	Runtime type information. More...

	valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	valuePointPatchField (const valuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

	valuePointPatchField (const valuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

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

virtual void	autoMap (const pointPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const pointPatchField< Type > &, const labelList &)
	Reverse map the given PointPatchField onto. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field. More...

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

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

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

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

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

virtual void	operator== (const Type &)

Public Member Functions inherited from pointPatchField< Type >
	TypeName ("pointPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

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

	pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

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

virtual	~pointPatchField ()
	Destructor. More...

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

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

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

const DimensionedField< Type, pointMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

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

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values. More...

tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const
	Return field created from appropriate internal field values. More...

tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
	Return field created from selected internal field values. More...

tmp< Field< Type > >	patchInternalField () const

void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...

void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
	Given the internal field and a patch field,. More...

void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
	Given the internal field and a patch field,. More...

void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...

virtual const word &	constraintType () const
	Return the constraint type this pointPatchField implements. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise evaluation of the patch field (do nothing) More...

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

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

virtual void	operator+= (const Type &)

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

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

virtual void	operator-= (const Type &)

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

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

virtual void	operator*= (const scalar)

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

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

virtual void	operator/= (const scalar)

Public Member Functions inherited from Field< Type >
	Field ()
	Construct null. More...

	Field (const label)
	Construct given size. More...

	Field (const label, const Type &)
	Construct given size and initial value. More...

	Field (const UList< Type > &)
	Construct as copy of a UList<Type> More...

	Field (const Xfer< List< Type > > &)
	Construct by transferring the List contents. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied uniform. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied values. More...

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

	Field (Field< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...

	Field (const Xfer< Field< Type > > &)
	Construct by transferring the Field contents. More...

	Field (const tmp< Field< Type > > &)
	Construct as copy of tmp<Field> More...

	Field (Istream &)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field. More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

void	operator= (const Field< Type > &)

void	operator= (const UList< Type > &)

void	operator= (const SubField< Type > &)

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

void	operator= (const Type &)

void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

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

void	operator= (const SubField< Type > &rhs)

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

void	operator= (const tmp< Field > &rhs)

void	operator= (const Type &t)

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

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

void	operator+= (const Type &)

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

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

void	operator-= (const Type &)

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

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

void	operator*= (const scalar &)

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

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

void	operator/= (const scalar &)

Private Attributes
autoPtr< DataEntry< Type > >	uniformValue_

Additional Inherited Members
Public Types inherited from pointPatchField< Type >
typedef pointPatch	Patch

Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Static Public Member Functions inherited from pointPatchField< Type >
static autoPtr< pointPatchField< Type > >	New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< Type > >	New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &)
	Return a pointer to a new CalculatedpointPatchField created on. More...

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

Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()
	Return a null field. More...

static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Static Public Attributes inherited from pointPatchField< Type >
static int	disallowGenericPointPatchField
	Debug switch to disallow the use of genericPointPatchField. More...

Static Public Attributes inherited from Field< Type >
static const char *const	typeName

Detailed Description

template<class Type>
class Foam::uniformFixedValuePointPatchField< Type >

Enables the specification of a uniform fixed value boundary condition.

Example of the boundary condition specification:

inlet
{
    type            uniformFixedValue;
    uniformValue    constant 0.2;
}

The uniformValue entry is a DataEntry type, able to describe time varying functions. The example above gives the usage for supplying a constant value.

Source files

Definition at line 63 of file uniformFixedValuePointPatchField.H.

Constructor & Destructor Documentation

◆ uniformFixedValuePointPatchField() [1/5]

uniformFixedValuePointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 38 of file uniformFixedValuePointPatchField.C.

◆ uniformFixedValuePointPatchField() [2/5]

uniformFixedValuePointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 51 of file uniformFixedValuePointPatchField.C.

References dict, dictionary::found(), fixedValuePointPatchField< Type >::operator=(), and p.

Here is the call graph for this function:

◆ uniformFixedValuePointPatchField() [3/5]

uniformFixedValuePointPatchField	(	const uniformFixedValuePointPatchField< Type > &	ptf,
		const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const pointPatchFieldMapper &	mapper
	)

Construct by mapping given patchField<Type> onto a new patch.

Definition at line 78 of file uniformFixedValuePointPatchField.C.

References fixedValuePointPatchField< Type >::operator=().

Here is the call graph for this function:

◆ uniformFixedValuePointPatchField() [4/5]

uniformFixedValuePointPatchField ( const uniformFixedValuePointPatchField< Type > & ptf )

Construct as copy.

Definition at line 97 of file uniformFixedValuePointPatchField.C.

◆ uniformFixedValuePointPatchField() [5/5]

uniformFixedValuePointPatchField	(	const uniformFixedValuePointPatchField< Type > &	ptf,
		const DimensionedField< Type, pointMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 109 of file uniformFixedValuePointPatchField.C.

References valuePointPatchField< Type >::operator==().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "uniformFixedValue" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValuePointPatchField< Type >.

Definition at line 111 of file uniformFixedValuePointPatchField.H.

◆ clone() [2/2]

virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValuePointPatchField< Type >.

Definition at line 132 of file uniformFixedValuePointPatchField.H.

◆ uniformValue()

const DataEntry<Type>& uniformValue ( ) const

inline

Return the uniform value.

Definition at line 152 of file uniformFixedValuePointPatchField.H.

References uniformFixedValuePointPatchField< Type >::uniformValue_.

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from valuePointPatchField< Type >.

Definition at line 126 of file uniformFixedValuePointPatchField.C.

References valuePointPatchField< Type >::operator==(), and valuePointPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from valuePointPatchField< Type >.

Definition at line 142 of file uniformFixedValuePointPatchField.C.

References valuePointPatchField< Type >::write().

Here is the call graph for this function:

Field Documentation

◆ uniformValue_

autoPtr<DataEntry<Type> > uniformValue_

private

Definition at line 69 of file uniformFixedValuePointPatchField.H.

Referenced by uniformFixedValuePointPatchField< Type >::uniformValue().

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

src/OpenFOAM/fields/pointPatchFields/derived/uniformFixedValue/uniformFixedValuePointPatchField.H
src/OpenFOAM/fields/pointPatchFields/derived/uniformFixedValue/uniformFixedValuePointPatchField.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformFixedValuePointPatchField< Type >

Constructor & Destructor Documentation

◆ uniformFixedValuePointPatchField() [1/5]

◆ uniformFixedValuePointPatchField() [2/5]

◆ uniformFixedValuePointPatchField() [3/5]

◆ uniformFixedValuePointPatchField() [4/5]

◆ uniformFixedValuePointPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ uniformValue()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ uniformValue_

template<class Type>
class Foam::uniformFixedValuePointPatchField< Type >