reader::options Class Reference

#include <ccmReader.H>

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

Detailed Description

Definition at line 768 of file ccmReader.H.

Constructor & Destructor Documentation

options()

options ( )

inlineconstexprnoexcept

Construct with default values.

Definition at line 829 of file ccmReader.H.

References e, and Foam::noexcept.

Member Function Documentation

keepFluid() [1/2]

bool keepFluid ( ) const

inlinenoexcept

Keep fluid regions (default true).

Definition at line 850 of file ccmReader.H.

References Foam::noexcept.

keepPorous() [1/2]

bool keepPorous ( ) const

inlinenoexcept

Keep porous regions (default true).

Definition at line 855 of file ccmReader.H.

References Foam::noexcept.

keepSolid() [1/2]

bool keepSolid ( ) const

inlinenoexcept

Keep solid regions (default true).

Definition at line 860 of file ccmReader.H.

References Foam::noexcept.

keptSomeRegion()

bool keptSomeRegion ( ) const

inlinenoexcept

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

Definition at line 865 of file ccmReader.H.

References Foam::noexcept.

mergeInterfaces() [1/2]

bool mergeInterfaces ( ) const

inlinenoexcept

Merge in-place interfaces (default true).

Definition at line 873 of file ccmReader.H.

References Foam::noexcept.

renameInterfaces() [1/2]

bool renameInterfaces ( ) const

inlinenoexcept

Rename interface boundaries as InterfaceN_0, InterfaceN_1.

(default true)

Definition at line 880 of file ccmReader.H.

References Foam::noexcept.

removeBaffles() [1/2]

bool removeBaffles ( ) const

inlinenoexcept

Remove baffles by merging their respective faces (default false).

Definition at line 885 of file ccmReader.H.

References Foam::noexcept.

useNumberedNames() [1/2]

bool useNumberedNames ( ) const

inlinenoexcept

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

names (default false)

Definition at line 892 of file ccmReader.H.

References Foam::noexcept.

mergeTol() [1/2]

scalar mergeTol ( ) const

inlinenoexcept

Merge tolerance for points (default 0.05e-3).

Definition at line 897 of file ccmReader.H.

References Foam::noexcept.

undefScalar() [1/2]

scalar undefScalar ( ) const

inlinenoexcept

Value to assign for undefined solutions (default: NaN).

Definition at line 902 of file ccmReader.H.

References Foam::noexcept.

keepFluid() [2/2]

void keepFluid ( bool b )

inlinenoexcept

Keep fluid regions.

Definition at line 910 of file ccmReader.H.

References b.

keepPorous() [2/2]

void keepPorous ( bool b )

inlinenoexcept

Keep porous regions.

Definition at line 915 of file ccmReader.H.

References b.

keepSolid() [2/2]

void keepSolid ( bool b )

inlinenoexcept

Keep solid regions.

Definition at line 920 of file ccmReader.H.

References b.

mergeInterfaces() [2/2]

void mergeInterfaces ( bool b )

inlinenoexcept

Merge in-place interfaces.

Definition at line 925 of file ccmReader.H.

References b.

renameInterfaces() [2/2]

void renameInterfaces ( bool b )

inlinenoexcept

Rename interface boundaries as InterfaceN_0, InterfaceN_1.

Definition at line 930 of file ccmReader.H.

References b.

removeBaffles() [2/2]

void removeBaffles ( bool b )

inlinenoexcept

Remove baffles by merging their respective faces.

Definition at line 935 of file ccmReader.H.

References b.

useNumberedNames() [2/2]

void useNumberedNames ( bool b )

inlinenoexcept

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

Definition at line 940 of file ccmReader.H.

References b.

mergeTol() [2/2]

void mergeTol ( scalar tol )

inlinenoexcept

Merge tolerance for points (default 0.05e-3).

Definition at line 945 of file ccmReader.H.

undefScalar() [2/2]

void undefScalar ( scalar val )

inlinenoexcept

Value to assign for undefined solutions (default: NaN).

Definition at line 950 of file ccmReader.H.

---

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

• src/conversion/ccm/reader/ccmReader.H