Loading...
Searching...
No Matches
copiedFixedValueFvPatchScalarField Class Reference

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

#include <copiedFixedValueFvPatchScalarField.H>

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

Public Member Functions

 TypeName ("copiedFixedValue")
 Runtime type information.
 copiedFixedValueFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
 copiedFixedValueFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given copiedFixedValueFvPatchScalarField onto a new patch.
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &)
 Construct as copy.
 copiedFixedValueFvPatchScalarField (const copiedFixedValueFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > > clone () const
 Return a clone.
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 Clone with an internal field reference.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Protected Attributes

word sourceFieldName_
 Name of the source field.

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 28 of file copiedFixedValueFvPatchScalarField.C.

References p, and sourceFieldName_.

Referenced by copiedFixedValueFvPatchScalarField(), copiedFixedValueFvPatchScalarField(), copiedFixedValueFvPatchScalarField(), and TypeName().

Here is the caller graph for this function:

◆ 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 39 of file copiedFixedValueFvPatchScalarField.C.

References dict, p, and sourceFieldName_.

◆ 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 51 of file copiedFixedValueFvPatchScalarField.C.

References copiedFixedValueFvPatchScalarField(), p, and sourceFieldName_.

Here is the call graph for this function:

◆ copiedFixedValueFvPatchScalarField() [4/5]

copiedFixedValueFvPatchScalarField ( const copiedFixedValueFvPatchScalarField & awfpsf)

Construct as copy.

Definition at line 64 of file copiedFixedValueFvPatchScalarField.C.

References copiedFixedValueFvPatchScalarField(), and sourceFieldName_.

Here is the call graph for this function:

◆ copiedFixedValueFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 74 of file copiedFixedValueFvPatchScalarField.C.

References copiedFixedValueFvPatchScalarField(), and sourceFieldName_.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "copiedFixedValue" )

Runtime type information.

References copiedFixedValueFvPatchScalarField().

Here is the call graph for this function:

◆ 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 175 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 sourceFieldName_.

◆ write()

void write ( Ostream & os) const
virtual

Write.

Definition at line 104 of file copiedFixedValueFvPatchScalarField.C.

References os(), sourceFieldName_, fvPatchField< Type >::write(), 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(), copiedFixedValueFvPatchScalarField(), copiedFixedValueFvPatchScalarField(), copiedFixedValueFvPatchScalarField(), copiedFixedValueFvPatchScalarField(), updateCoeffs(), and write().

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