uniformNormalFixedValueFvPatchVectorField Class Reference

This boundary condition provides a uniform surface-normal vector boundary condition by its magnitude. More...

Inheritance diagram for uniformNormalFixedValueFvPatchVectorField:

Collaboration diagram for uniformNormalFixedValueFvPatchVectorField:

Public Member Functions
	TypeName ("uniformNormalFixedValue")
	Runtime type information. More...
	uniformNormalFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. More...
	uniformNormalFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	uniformNormalFixedValueFvPatchVectorField (const uniformNormalFixedValueFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...
	uniformNormalFixedValueFvPatchVectorField (const uniformNormalFixedValueFvPatchVectorField &)
	Construct as copy. More...
virtual tmp< fvPatchVectorField >	clone () const
	Construct and return a clone. More...
	uniformNormalFixedValueFvPatchVectorField (const uniformNormalFixedValueFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference. More...
virtual tmp< fvPatchVectorField >	clone (const DimensionedField< vector, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...
virtual void	rmap (const fvPatchVectorField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...
virtual void	write (Ostream &os) const
	Write. More...

Detailed Description

This boundary condition provides a uniform surface-normal vector boundary condition by its magnitude.

Usage

Property	Description	Required	Default
uniformValue	uniform value	yes
ramp	time-based ramping	no

Example of the boundary condition specification:

    <patchName>
    {
        type            uniformNormalFixedValue;
        uniformValue    constant -10;          // 10 INTO the domain
    }

Note

Sign conventions:

• the value is positive for outward-pointing vectors

See also

Foam::Function1Types Foam::fixedValueFvPatchField Foam::surfaceNormalFixedValueFvPatchVectorField Foam::uniformFixedValueFvPatchVectorField

Source files

• uniformNormalFixedValueFvPatchVectorField.H
• uniformNormalFixedValueFvPatchVectorField.C

Definition at line 97 of file uniformNormalFixedValueFvPatchVectorField.H.

Constructor & Destructor Documentation

uniformNormalFixedValueFvPatchVectorField() [1/5]

uniformNormalFixedValueFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file uniformNormalFixedValueFvPatchVectorField.C.

uniformNormalFixedValueFvPatchVectorField() [2/5]

uniformNormalFixedValueFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 48 of file uniformNormalFixedValueFvPatchVectorField.C.

References dict, dictionary::found(), fvPatchField< vector >::operator, p, and UList< T >::size().

Here is the call graph for this function:

uniformNormalFixedValueFvPatchVectorField() [3/5]

uniformNormalFixedValueFvPatchVectorField	(	const uniformNormalFixedValueFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

uniformNormalFixedValueFvPatchVectorField onto a new patch

Definition at line 74 of file uniformNormalFixedValueFvPatchVectorField.C.

References FieldMapper::direct(), and FieldMapper::hasUnmapped().

Here is the call graph for this function:

uniformNormalFixedValueFvPatchVectorField() [4/5]

uniformNormalFixedValueFvPatchVectorField

(

const uniformNormalFixedValueFvPatchVectorField &

ptf

)

Construct as copy.

Definition at line 100 of file uniformNormalFixedValueFvPatchVectorField.C.

uniformNormalFixedValueFvPatchVectorField() [5/5]

uniformNormalFixedValueFvPatchVectorField	(	const uniformNormalFixedValueFvPatchVectorField &	ptf,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 112 of file uniformNormalFixedValueFvPatchVectorField.C.

Member Function Documentation

TypeName()

TypeName

(

"uniformNormalFixedValue"

)

Runtime type information.

clone() [1/2]

virtual tmp< fvPatchVectorField > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 150 of file uniformNormalFixedValueFvPatchVectorField.H.

clone() [2/2]

virtual tmp< fvPatchVectorField > clone ( const DimensionedField< vector, volMesh > &  iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 166 of file uniformNormalFixedValueFvPatchVectorField.H.

autoMap()

void autoMap ( const fvPatchFieldMapper &  mapper )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 127 of file uniformNormalFixedValueFvPatchVectorField.C.

rmap()

void rmap ( const fvPatchVectorField &  ptf, const labelList &  addr  )

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 143 of file uniformNormalFixedValueFvPatchVectorField.C.

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 158 of file uniformNormalFixedValueFvPatchVectorField.C.

References fvPatchField< vector >::operator=(), tmp< T >::ref(), and fvPatchField< vector >::updateCoeffs().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Definition at line 179 of file uniformNormalFixedValueFvPatchVectorField.C.

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

Here is the call graph for this function:

---

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

• src/finiteVolume/fields/fvPatchFields/derived/uniformNormalFixedValue/uniformNormalFixedValueFvPatchVectorField.H
• src/finiteVolume/fields/fvPatchFields/derived/uniformNormalFixedValue/uniformNormalFixedValueFvPatchVectorField.C