SCOREC core
Parallel unstructured mesh tools
Public Attributes | List of all members
ma::Input Class Reference

User configuration for a MeshAdapt run. More...

Public Attributes

int maximumIterations
 number of refine/coarsen iterations to run (default 3) More...
 
bool shouldCoarsen
 whether to perform the collapse step
 
bool shouldSnap
 whether to snap new vertices to the model surface More...
 
bool shouldTransferParametric
 whether to transfer parametric coordinates More...
 
bool shouldTransferToClosestPoint
 whether to transfer to the parametric coords of the closest point More...
 
bool shouldHandleMatching
 whether to update matched entity info (limited support)
 
bool shouldFixShape
 whether to run shape correction (default true)
 
bool shouldForceAdaptation
 whether to adapt if it makes local quality worse (default false)
 
bool shouldPrintQuality
 whether to print the worst shape quality
 
double goodQuality
 minimum desired mean ratio cubed for simplex elements More...
 
double shouldCheckQualityForDoubleSplits
 whether to check the quality of split elems in DoubleSplitsCollapse (default false)
 
double validQuality
 minimum valid mean ratio cubed for simplex elements (default 1e-10) More...
 
double maximumImbalance
 imbalance target for all load balancing tools (default 1.10)
 
bool shouldRunPreZoltan
 whether to run zoltan predictive load balancing (default false) More...
 
bool shouldRunPreZoltanRib
 whether to run zoltan predictive load balancing using RIB (default false) More...
 
bool shouldRunPreMetis
 Whether to run METIS before adaptation (default false) More...
 
bool shouldRunPreParma
 whether to run parma predictive load balancing (default false) More...
 
bool shouldRunMidZoltan
 whether to run zoltan during adaptation (default false) More...
 
bool shouldRunMidMetis
 Whether to run METIS during adaptation (default false) More...
 
bool shouldRunMidParma
 whether to run parma during adaptation (default false) More...
 
bool shouldRunPostZoltan
 whether to run zoltan after adapting (default false) More...
 
bool shouldRunPostZoltanRib
 whether to run zoltan RIB after adapting (default false) More...
 
bool shouldRunPostMetis
 Whether to run METIS after adaptation (default false) More...
 
bool shouldRunPostParma
 whether to run parma after adapting (default false) More...
 
double maximumEdgeRatio
 the ratio between longest and shortest edges that differentiates a "short edge" element from a "large angle" element.
 
bool shouldTurnLayerToTets
 whether to tetrahedronize the boundary layer (default false)

 
bool shouldCleanupLayer
 whether to tetrahedronize abnormal pyramids (default false)
 
bool shouldRefineLayer
 whether to allow layer refinement (default false)
 
bool shouldCoarsenLayer
 whether to allow layer coarsening (default false)
 
bool splitAllLayerEdges
 set to true during UR to get splits in the normal direction
 
const char * userDefinedLayerTagName
 the name of the (user defined) INT tag specifying the boundary layer elements. Use the value of 0 for non-layer elements and a non-zero value for layer elements. (default "")
 
const char * debugFolder
 this a folder that debugging meshes will be written to, if provided!
 

Detailed Description

User configuration for a MeshAdapt run.

Definition at line 34 of file maInput.h.

Member Data Documentation

◆ goodQuality

double ma::Input::goodQuality

minimum desired mean ratio cubed for simplex elements

a different measure is used for curved elements

Definition at line 73 of file maInput.h.

◆ maximumIterations

int ma::Input::maximumIterations

number of refine/coarsen iterations to run (default 3)

this value will be set to the minimum required iterations inside the call to ma::configure in cases where there is a size information. Users can override this by setting in->maximumIterations after the call to ma::configure and before the call to ma::adapt routine.

Definition at line 51 of file maInput.h.

◆ shouldRunMidMetis

bool ma::Input::shouldRunMidMetis

Whether to run METIS during adaptation (default false)

If all mid-balance options are false, mid-balancing only occurs if the estimated imbalance is greater than in->maximumImbalance.

Note
This option collects necessary mesh topology information on rank 0, runs METIS serially, then sends the migration plan to the remaining processes. It is only intended to be used on a single node.

Definition at line 120 of file maInput.h.

◆ shouldRunMidParma

bool ma::Input::shouldRunMidParma

whether to run parma during adaptation (default false)

if this and all the other MidBalance options are false, mid-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 124 of file maInput.h.

◆ shouldRunMidZoltan

bool ma::Input::shouldRunMidZoltan

whether to run zoltan during adaptation (default false)

if this and all the other MidBalance options are false, mid-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 109 of file maInput.h.

◆ shouldRunPostMetis

bool ma::Input::shouldRunPostMetis

Whether to run METIS after adaptation (default false)

If all post-balance options are false, post-balancing only occurs if the estimated imbalance is greater than in->maximumImbalance.

Note
This option collects necessary mesh topology information on rank 0, runs METIS serially, then sends the migration plan to the remaining processes. It is only intended to be used on a single node.

Definition at line 143 of file maInput.h.

◆ shouldRunPostParma

bool ma::Input::shouldRunPostParma

whether to run parma after adapting (default false)

if this and all the other PostBalance options are false, post-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 147 of file maInput.h.

◆ shouldRunPostZoltan

bool ma::Input::shouldRunPostZoltan

whether to run zoltan after adapting (default false)

if this and all the other PostBalance options are false, post-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 128 of file maInput.h.

◆ shouldRunPostZoltanRib

bool ma::Input::shouldRunPostZoltanRib

whether to run zoltan RIB after adapting (default false)

if this and all the other PostBalance options are false, post-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 132 of file maInput.h.

◆ shouldRunPreMetis

bool ma::Input::shouldRunPreMetis

Whether to run METIS before adaptation (default false)

If all pre-balance options are false, pre-balancing only occurs if the estimated imbalance is greater than in->maximumImbalance.

Note
This option collects necessary mesh topology information on rank 0, runs METIS serially, then sends the migration plan to the remaining processes. It is only intended to be used on a single node.

Definition at line 101 of file maInput.h.

◆ shouldRunPreParma

bool ma::Input::shouldRunPreParma

whether to run parma predictive load balancing (default false)

if this and all the other PreBalance options are false, pre-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 105 of file maInput.h.

◆ shouldRunPreZoltan

bool ma::Input::shouldRunPreZoltan

whether to run zoltan predictive load balancing (default false)

if this and all the other PreBalance options are false, pre-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 86 of file maInput.h.

◆ shouldRunPreZoltanRib

bool ma::Input::shouldRunPreZoltanRib

whether to run zoltan predictive load balancing using RIB (default false)

if this and all the other PreBalance options are false, pre-balancing occurs only if the imbalance is greater than in->maximumImbalance

Definition at line 90 of file maInput.h.

◆ shouldSnap

bool ma::Input::shouldSnap

whether to snap new vertices to the model surface

requires modeler support, see gmi_can_eval

Definition at line 56 of file maInput.h.

◆ shouldTransferParametric

bool ma::Input::shouldTransferParametric

whether to transfer parametric coordinates

requires modeler support, see gmi_reparam

Definition at line 59 of file maInput.h.

◆ shouldTransferToClosestPoint

bool ma::Input::shouldTransferToClosestPoint

whether to transfer to the parametric coords of the closest point

requires modeler support, see gmi_closest_point

Definition at line 62 of file maInput.h.

◆ validQuality

double ma::Input::validQuality

minimum valid mean ratio cubed for simplex elements (default 1e-10)

used to define inside-out tetrahedra. a different measure is used for curved elements

Definition at line 80 of file maInput.h.


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