patchExprFieldBase Class Reference

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

Inheritance diagram for patchExprFieldBase:

Collaboration diagram for patchExprFieldBase:

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

• patchExprFieldBase.H
• patchExprFieldBase.cxx

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.

patchExprFieldBase() [2/2]

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

explicit

Construct from dictionary.

Member Function Documentation

write()

void write

(

Ostream &

os

)

const

Write.

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 106 of file patchExprFieldBase.H.

valueExpr_

expressions::exprString valueExpr_

protected

Definition at line 109 of file patchExprFieldBase.H.

gradExpr_

expressions::exprString gradExpr_

protected

Definition at line 110 of file patchExprFieldBase.H.

fracExpr_

expressions::exprString fracExpr_

protected

Definition at line 111 of file patchExprFieldBase.H.

---

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

• src/finiteVolume/expressions/fields/base/patchExprFieldBase.H