copiedFixedValueFvPatchScalarField Class Reference

Copies the boundary values from a user specified field. More...

Inheritance diagram for copiedFixedValueFvPatchScalarField:
[legend]
Collaboration diagram for copiedFixedValueFvPatchScalarField:
[legend]

Public Member Functions

 TypeName ("copiedFixedValue")
 Runtime type information. More...
 
 copiedFixedValueFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 copiedFixedValueFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Protected Attributes

word sourceFieldName_
 Name of the source field. More...
 

Detailed Description

Copies the boundary values from a user specified field.

Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries
    type                copiedFixedValue;
    sourceFieldName     <word>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: copiedFixedValue word yes -
sourceFieldName Name of the source field word yes -

The inherited entries are elaborated in:

See also
Foam::fixedValueFvPatchField
Source files

Definition at line 96 of file copiedFixedValueFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ copiedFixedValueFvPatchScalarField() [1/5]

copiedFixedValueFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 35 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [2/5]

copiedFixedValueFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 46 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [3/5]

copiedFixedValueFvPatchScalarField ( const copiedFixedValueFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping given copiedFixedValueFvPatchScalarField onto a new patch

Definition at line 58 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 71 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 81 of file copiedFixedValueFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "copiedFixedValue"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 148 of file copiedFixedValueFvPatchScalarField.H.

◆ clone() [2/2]

virtual tmp< fvPatchScalarField > clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 164 of file copiedFixedValueFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 95 of file copiedFixedValueFvPatchScalarField.C.

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 111 of file copiedFixedValueFvPatchScalarField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ sourceFieldName_

word sourceFieldName_
protected

Name of the source field.

Definition at line 105 of file copiedFixedValueFvPatchScalarField.H.


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