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")
 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 &)
 Construct by mapping given copiedFixedValueFvPatchScalarField onto a new patch. More...
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &)
 Construct as copy. More...
 
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< scalar > > clone () const
 Return a clone. More...
 
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 Clone with an 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 92 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 29 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 40 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 52 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [4/5]

copiedFixedValueFvPatchScalarField ( const copiedFixedValueFvPatchScalarField &  awfpsf)

Construct as copy.

Definition at line 65 of file copiedFixedValueFvPatchScalarField.C.

◆ copiedFixedValueFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 75 of file copiedFixedValueFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "copiedFixedValue"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<scalar> > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 167 of file copiedFixedValueFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 176 of file copiedFixedValueFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 88 of file copiedFixedValueFvPatchScalarField.C.

References Foam::foamVersion::patch, and copiedFixedValueFvPatchScalarField::sourceFieldName_.

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 104 of file copiedFixedValueFvPatchScalarField.C.

References os(), fvPatchField< Type >::write(), Ostream::writeEntry(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

Member Data Documentation

◆ sourceFieldName_

word sourceFieldName_
protected

Name of the source field.

Definition at line 103 of file copiedFixedValueFvPatchScalarField.H.

Referenced by copiedFixedValueFvPatchScalarField::updateCoeffs().

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