Public Member Functions | Protected Attributes | List of all members
copiedFixedValueFvPatchScalarField Class Reference

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

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

Public Member Functions

 TypeName ("copiedFixedValue")
 
 copiedFixedValueFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 copiedFixedValueFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &)
 
virtual tmp< fvPatchScalarFieldclone () const
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &) const
 

Protected Attributes

word sourceFieldName_
 

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 92 of file copiedFixedValueFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ copiedFixedValueFvPatchScalarField() [1/5]

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

Definition at line 29 of file copiedFixedValueFvPatchScalarField.C.

Referenced by copiedFixedValueFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ copiedFixedValueFvPatchScalarField() [2/5]

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

Definition at line 40 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [3/5]

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

Definition at line 52 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [4/5]

Definition at line 65 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [5/5]

Definition at line 75 of file copiedFixedValueFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "copiedFixedValue"  )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Definition at line 144 of file copiedFixedValueFvPatchScalarField.H.

References copiedFixedValueFvPatchScalarField::copiedFixedValueFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

Definition at line 161 of file copiedFixedValueFvPatchScalarField.H.

References copiedFixedValueFvPatchScalarField::copiedFixedValueFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ write()

void write ( Ostream os) const
virtual

Definition at line 104 of file copiedFixedValueFvPatchScalarField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ sourceFieldName_

word sourceFieldName_
protected

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