Public Member Functions | List of all members
reader::options Class Reference

Public Member Functions

 options ()
 Construct with the defaults. More...
 
bool keepFluid () const
 Keep fluid regions (default true) More...
 
bool keepPorous () const
 Keep porous regions (default true) More...
 
bool keepSolid () const
 Keep solid regions (default true) More...
 
bool keptSomeRegion () const
 Some region (fluid, porous, solid) is kept. More...
 
bool mergeInterfaces () const
 Merge in-place interfaces (default true) More...
 
bool renameInterfaces () const
 Rename interface boundaries as InterfaceN_0, InterfaceN_1. More...
 
bool removeBaffles () const
 Remove baffles by merging their respective faces (default false) More...
 
bool useNumberedNames () const
 Use numbered names (eg, patch_0, zone_0) instead of human-readable. More...
 
scalar mergeTol () const
 Merge tolerance for points (default 0.05e-3) More...
 
scalar undefScalar () const
 Value to assign for undefined solutions (default: NaN) More...
 
void keepFluid (bool b)
 Keep fluid regions. More...
 
void keepPorous (bool b)
 Keep porous regions. More...
 
void keepSolid (bool b)
 Keep solid regions. More...
 
void mergeInterfaces (bool b)
 Merge in-place interfaces. More...
 
void renameInterfaces (bool b)
 Rename interface boundaries as InterfaceN_0, InterfaceN_1. More...
 
void removeBaffles (bool b)
 Remove baffles by merging their respective faces. More...
 
void useNumberedNames (bool b)
 Use numbered names (eg, patch_0, zone_0) instead of human-readable. More...
 
void mergeTol (const scalar &tol)
 Merge tolerance for points (default 0.05e-3) More...
 
void undefScalar (const scalar &val)
 Value to assign for undefined solutions (default: NaN) More...
 

Detailed Description

Definition at line 587 of file ccmReader.H.

Constructor & Destructor Documentation

◆ options()

options ( )

Construct with the defaults.

Definition at line 32 of file ccmReaderOptions.C.

Member Function Documentation

◆ keepFluid() [1/2]

bool keepFluid ( ) const

Keep fluid regions (default true)

Definition at line 48 of file ccmReaderOptions.C.

◆ keepPorous() [1/2]

bool keepPorous ( ) const

Keep porous regions (default true)

Definition at line 54 of file ccmReaderOptions.C.

◆ keepSolid() [1/2]

bool keepSolid ( ) const

Keep solid regions (default true)

Definition at line 60 of file ccmReaderOptions.C.

◆ keptSomeRegion()

bool keptSomeRegion ( ) const

Some region (fluid, porous, solid) is kept.

Definition at line 66 of file ccmReaderOptions.C.

◆ mergeInterfaces() [1/2]

bool mergeInterfaces ( ) const

Merge in-place interfaces (default true)

Definition at line 72 of file ccmReaderOptions.C.

◆ renameInterfaces() [1/2]

bool renameInterfaces ( ) const

Rename interface boundaries as InterfaceN_0, InterfaceN_1.

(default true)

Definition at line 78 of file ccmReaderOptions.C.

◆ removeBaffles() [1/2]

bool removeBaffles ( ) const

Remove baffles by merging their respective faces (default false)

Definition at line 84 of file ccmReaderOptions.C.

◆ useNumberedNames() [1/2]

bool useNumberedNames ( ) const

Use numbered names (eg, patch_0, zone_0) instead of human-readable.

names (default false)

Definition at line 90 of file ccmReaderOptions.C.

◆ mergeTol() [1/2]

Foam::scalar mergeTol ( ) const

Merge tolerance for points (default 0.05e-3)

Definition at line 96 of file ccmReaderOptions.C.

◆ undefScalar() [1/2]

Foam::scalar undefScalar ( ) const

Value to assign for undefined solutions (default: NaN)

Definition at line 102 of file ccmReaderOptions.C.

◆ keepFluid() [2/2]

void keepFluid ( bool  b)

Keep fluid regions.

Definition at line 109 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ keepPorous() [2/2]

void keepPorous ( bool  b)

Keep porous regions.

Definition at line 115 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ keepSolid() [2/2]

void keepSolid ( bool  b)

Keep solid regions.

Definition at line 121 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ mergeInterfaces() [2/2]

void mergeInterfaces ( bool  b)

Merge in-place interfaces.

Definition at line 127 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ renameInterfaces() [2/2]

void renameInterfaces ( bool  b)

Rename interface boundaries as InterfaceN_0, InterfaceN_1.

Definition at line 133 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ removeBaffles() [2/2]

void removeBaffles ( bool  b)

Remove baffles by merging their respective faces.

Definition at line 139 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ useNumberedNames() [2/2]

void useNumberedNames ( bool  b)

Use numbered names (eg, patch_0, zone_0) instead of human-readable.

Definition at line 145 of file ccmReaderOptions.C.

References Foam::constant::physicoChemical::b.

◆ mergeTol() [2/2]

void mergeTol ( const scalar &  tol)

Merge tolerance for points (default 0.05e-3)

Definition at line 151 of file ccmReaderOptions.C.

◆ undefScalar() [2/2]

void undefScalar ( const scalar &  val)

Value to assign for undefined solutions (default: NaN)

Definition at line 157 of file ccmReaderOptions.C.

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