Loading...
Searching...
No Matches
patchExprFieldBase Class Reference

Base class for managing patches with expressions. The expected input supports value, gradient and mixed conditions. More...

#include <patchExprFieldBase.H>

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

Public Member Functions

 patchExprFieldBase ()
 Default construct.
 patchExprFieldBase (const dictionary &dict, enum expectedTypes expectedType=expectedTypes::VALUE_TYPE, bool wantPointData=false)
 Construct from dictionary.
void write (Ostream &os) const
 Write.

Protected Types

enum  expectedTypes { VALUE_TYPE = 1 , GRADIENT_TYPE = 2 , MIXED_TYPE = 3 }
 Enumeration of expected expressions. More...

Protected Attributes

bool debug_
 Add debugging.
bool evalOnConstruct_
 Slightly dodgy concept here.
expressions::exprString valueExpr_
expressions::exprString gradExpr_
expressions::exprString fracExpr_

Detailed Description

Base class for managing patches with expressions. The expected input supports value, gradient and mixed conditions.

Usage
Property Description Required Default
valueExpr expression for uniformValue partly 0
gradientExpr expression for uniformGradient partly 0
fractionExpr expression for valueFraction partly depends
Source files

Definition at line 79 of file patchExprFieldBase.H.

Member Enumeration Documentation

◆ expectedTypes

enum expectedTypes
protected

Enumeration of expected expressions.

Enumerator
VALUE_TYPE 
GRADIENT_TYPE 
MIXED_TYPE 

Definition at line 88 of file patchExprFieldBase.H.

Constructor & Destructor Documentation

◆ patchExprFieldBase() [1/2]

patchExprFieldBase ( )

Default construct.

Definition at line 108 of file patchExprFieldBase.C.

References debug_, evalOnConstruct_, fracExpr_, gradExpr_, and valueExpr_.

Referenced by exprFixedValueFvPatchField< Type >::exprFixedValueFvPatchField(), exprFixedValueFvPatchField< Type >::exprFixedValueFvPatchField(), exprFixedValueFvPatchField< Type >::exprFixedValueFvPatchField(), exprFixedValueFvPatchField< Type >::exprFixedValueFvPatchField(), exprFixedValueFvPatchField< Type >::exprFixedValueFvPatchField(), exprMixedFvPatchField< Type >::exprMixedFvPatchField(), exprMixedFvPatchField< Type >::exprMixedFvPatchField(), exprMixedFvPatchField< Type >::exprMixedFvPatchField(), exprMixedFvPatchField< Type >::exprMixedFvPatchField(), exprMixedFvPatchField< Type >::exprMixedFvPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), exprValuePointPatchField< Type >::exprValuePointPatchField(), and exprValuePointPatchField< Type >::exprValuePointPatchField().

Here is the caller graph for this function:

◆ patchExprFieldBase() [2/2]

patchExprFieldBase ( const dictionary & dict,
enum expectedTypes expectedType = expectedTypes::VALUE_TYPE,
bool wantPointData = false )
explicit

Construct from dictionary.

Definition at line 118 of file patchExprFieldBase.C.

References debug_, dict, evalOnConstruct_, fracExpr_, gradExpr_, and valueExpr_.

Member Function Documentation

◆ write()

void write ( Ostream & os) const

Write.

Definition at line 137 of file patchExprFieldBase.C.

References evalOnConstruct_, fracExpr_, gradExpr_, os(), and valueExpr_.

Referenced by exprFixedValueFvPatchField< Type >::write(), exprMixedFvPatchField< Type >::write(), and exprValuePointPatchField< Type >::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ debug_

bool debug_
protected

Add debugging.

Definition at line 101 of file patchExprFieldBase.H.

Referenced by patchExprFieldBase(), patchExprFieldBase(), exprFixedValueFvPatchField< Type >::setDebug(), exprMixedFvPatchField< Type >::setDebug(), exprFixedValueFvPatchField< Type >::write(), exprMixedFvPatchField< Type >::write(), and exprValuePointPatchField< Type >::write().

◆ evalOnConstruct_

bool evalOnConstruct_
protected

Slightly dodgy concept here.

Definition at line 106 of file patchExprFieldBase.H.

Referenced by patchExprFieldBase(), patchExprFieldBase(), and write().

◆ valueExpr_

expressions::exprString valueExpr_
protected

Definition at line 109 of file patchExprFieldBase.H.

Referenced by patchExprFieldBase(), patchExprFieldBase(), exprFixedValueFvPatchField< Type >::updateCoeffs(), exprMixedFvPatchField< Type >::updateCoeffs(), exprValuePointPatchField< Type >::updateCoeffs(), and write().

◆ gradExpr_

expressions::exprString gradExpr_
protected

Definition at line 110 of file patchExprFieldBase.H.

Referenced by patchExprFieldBase(), patchExprFieldBase(), exprMixedFvPatchField< Type >::updateCoeffs(), and write().

◆ fracExpr_

expressions::exprString fracExpr_
protected

Definition at line 111 of file patchExprFieldBase.H.

Referenced by patchExprFieldBase(), patchExprFieldBase(), exprMixedFvPatchField< Type >::updateCoeffs(), and write().

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