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

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

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

Public Member Functions

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

Protected Types

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

Protected Attributes

bool debug_
 Add debugging. More...
 
bool evalOnConstruct_
 Slightly dodgy concept here. More...
 
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 83 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 90 of file patchExprFieldBase.H.

Constructor & Destructor Documentation

◆ patchExprFieldBase() [1/2]

patchExprFieldBase ( )

Default construct.

Definition at line 141 of file patchExprFieldBase.C.

◆ patchExprFieldBase() [2/2]

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

Construct from dictionary.

Definition at line 151 of file patchExprFieldBase.C.

References dict.

Member Function Documentation

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 170 of file patchExprFieldBase.C.

References os().

Here is the call graph for this function:

Member Data Documentation

◆ debug_

bool debug_
protected

Add debugging.

Definition at line 101 of file patchExprFieldBase.H.

◆ evalOnConstruct_

bool evalOnConstruct_
protected

Slightly dodgy concept here.

Definition at line 104 of file patchExprFieldBase.H.

◆ valueExpr_

expressions::exprString valueExpr_
protected

Definition at line 107 of file patchExprFieldBase.H.

◆ gradExpr_

expressions::exprString gradExpr_
protected

Definition at line 108 of file patchExprFieldBase.H.

◆ fracExpr_

expressions::exprString fracExpr_
protected

Definition at line 109 of file patchExprFieldBase.H.

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