PDRparams Class Reference

Parameters for PDRsetFields. More...

Collaboration diagram for PDRparams:
[legend]

Public Member Functions

 PDRparams ()=default
 Default construct. More...
 
void readDefaults (const dictionary &dict)
 Set or read defaults from dictionary. More...
 
void read (const dictionary &dict)
 Read program parameters from dictionary. More...
 

Public Attributes

fileName obsfile_dir
 
wordList obsfile_names
 
word timeName
 
word groundPatchName
 The name for the "ground" patch. More...
 
word outerPatchName
 The name for the "outer" patch. More...
 
string UPatchBc
 "fixedValue;value uniform (0 0 0)" More...
 
bool legacyMeshSpec {false}
 
bool legacyObsSpec {false}
 
bool two_d {false}
 
bool yCyclic {false}
 
bool ySymmetry {false}
 
bool deluge {false}
 
bool new_fields {true}
 
bool noIntersectN {true}
 
bool blockedFacesWallFn {false}
 
bool ignoreGratings {false}
 
bool outer_orthog {false}
 
int debugLevel {0}
 
int nFacesToBlockC {6}
 
int nPairsToBlockC {3}
 
int overlaps {0x7}
 Flag to control which overlap calculations are performed. More...
 
scalar gridPointTol {0.02}
 
scalar cb_r {0.035}
 
scalar cb_s {0.08}
 
scalar cd_r {1.2}
 
scalar cd_s {2.0}
 
scalar cong_max_betav {1.0}
 
scalar min_overlap_vol {0}
 
scalar min_overlap_area {0}
 
scalar min_width {0.001}
 Ignore obstacles with second dimension (or diameter) less than this. More...
 
scalar empty_lobs_fac {1.0}
 Lobs in empty cell is this * cube root of cell volume. More...
 
scalar outerCombFac {1.0}
 Value for outer region. More...
 
scalar obs_expand {0}
 
scalar def_grating_slat_w {0.005}
 Default slat thickness grating. More...
 
scalar blockedCellPoros {0.05}
 Cells with porosity less than this are blocked. More...
 
scalar blockedFacePar {0.95}
 Faces with area blockage greater than this are blocked. More...
 
scalar maxCR {1e30}
 Upper limit on CR (CT also gets limited) More...
 
scalar blockageNoCT {0.95}
 
scalar scale {1.0}
 Overall scale factor. More...
 

Detailed Description

Parameters for PDRsetFields.

Source files

Definition at line 55 of file PDRparams.H.

Constructor & Destructor Documentation

◆ PDRparams()

PDRparams ( )
default

Default construct.

Member Function Documentation

◆ readDefaults()

void readDefaults ( const dictionary dict)

Set or read defaults from dictionary.

Can also be used with an empty dictionary

◆ read()

void read ( const dictionary dict)

Read program parameters from dictionary.

Member Data Documentation

◆ obsfile_dir

fileName obsfile_dir

Definition at line 61 of file PDRparams.H.

◆ obsfile_names

wordList obsfile_names

Definition at line 62 of file PDRparams.H.

◆ timeName

word timeName

Definition at line 63 of file PDRparams.H.

◆ groundPatchName

word groundPatchName

The name for the "ground" patch.

Definition at line 66 of file PDRparams.H.

◆ outerPatchName

word outerPatchName

The name for the "outer" patch.

Definition at line 69 of file PDRparams.H.

◆ UPatchBc

string UPatchBc

"fixedValue;value uniform (0 0 0)"

Definition at line 71 of file PDRparams.H.

◆ legacyMeshSpec

bool legacyMeshSpec {false}

Definition at line 73 of file PDRparams.H.

◆ legacyObsSpec

bool legacyObsSpec {false}

Definition at line 74 of file PDRparams.H.

◆ two_d

bool two_d {false}

Definition at line 76 of file PDRparams.H.

◆ yCyclic

bool yCyclic {false}

Definition at line 77 of file PDRparams.H.

◆ ySymmetry

bool ySymmetry {false}

Definition at line 78 of file PDRparams.H.

◆ deluge

bool deluge {false}

Definition at line 79 of file PDRparams.H.

◆ new_fields

bool new_fields {true}

Definition at line 80 of file PDRparams.H.

◆ noIntersectN

bool noIntersectN {true}

Definition at line 81 of file PDRparams.H.

◆ blockedFacesWallFn

bool blockedFacesWallFn {false}

Definition at line 82 of file PDRparams.H.

◆ ignoreGratings

bool ignoreGratings {false}

Definition at line 83 of file PDRparams.H.

◆ outer_orthog

bool outer_orthog {false}

Definition at line 84 of file PDRparams.H.

◆ debugLevel

int debugLevel {0}

Definition at line 86 of file PDRparams.H.

◆ nFacesToBlockC

int nFacesToBlockC {6}

Min number of blocked cell faces for a cell to be marked as blocked

Definition at line 90 of file PDRparams.H.

◆ nPairsToBlockC

int nPairsToBlockC {3}

Min number of blocked cell face pairs (on opposite faces of a cell) for a cell to be marked as blocked

Definition at line 94 of file PDRparams.H.

◆ overlaps

int overlaps {0x7}

Flag to control which overlap calculations are performed.

Definition at line 97 of file PDRparams.H.

Referenced by trackingInverseDistance::markBoundaries(), trackingInverseDistance::markPatchesAsHoles(), and searchableBox::overlaps().

◆ gridPointTol

scalar gridPointTol {0.02}

Definition at line 99 of file PDRparams.H.

◆ cb_r

scalar cb_r {0.035}

Definition at line 101 of file PDRparams.H.

◆ cb_s

scalar cb_s {0.08}

Definition at line 102 of file PDRparams.H.

◆ cd_r

scalar cd_r {1.2}

Definition at line 104 of file PDRparams.H.

◆ cd_s

scalar cd_s {2.0}

Definition at line 105 of file PDRparams.H.

◆ cong_max_betav

scalar cong_max_betav {1.0}

Definition at line 107 of file PDRparams.H.

◆ min_overlap_vol

scalar min_overlap_vol {0}

Definition at line 109 of file PDRparams.H.

◆ min_overlap_area

scalar min_overlap_area {0}

Definition at line 110 of file PDRparams.H.

◆ min_width

scalar min_width {0.001}

Ignore obstacles with second dimension (or diameter) less than this.

Definition at line 113 of file PDRparams.H.

◆ empty_lobs_fac

scalar empty_lobs_fac {1.0}

Lobs in empty cell is this * cube root of cell volume.

Definition at line 116 of file PDRparams.H.

◆ outerCombFac

scalar outerCombFac {1.0}

Value for outer region.

Definition at line 119 of file PDRparams.H.

◆ obs_expand

scalar obs_expand {0}

Definition at line 121 of file PDRparams.H.

◆ def_grating_slat_w

scalar def_grating_slat_w {0.005}

Default slat thickness grating.

Definition at line 124 of file PDRparams.H.

◆ blockedCellPoros

scalar blockedCellPoros {0.05}

Cells with porosity less than this are blocked.

Definition at line 127 of file PDRparams.H.

◆ blockedFacePar

scalar blockedFacePar {0.95}

Faces with area blockage greater than this are blocked.

Definition at line 130 of file PDRparams.H.

◆ maxCR

scalar maxCR {1e30}

Upper limit on CR (CT also gets limited)

Definition at line 133 of file PDRparams.H.

◆ blockageNoCT

scalar blockageNoCT {0.95}

If a single obstacle blocks a cell by more than this, then no CT in that direction

Definition at line 137 of file PDRparams.H.

◆ scale

scalar scale {1.0}

Overall scale factor.

Definition at line 140 of file PDRparams.H.


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