SCOREC core
Parallel unstructured mesh tools
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
maInput.h
Go to the documentation of this file.
1 /******************************************************************************
2 
3  Copyright 2013 Scientific Computation Research Center,
4  Rensselaer Polytechnic Institute. All rights reserved.
5 
6  The LICENSE file included with this distribution describes the terms
7  of the SCOREC Non-Commercial License this program is distributed under.
8 
9 *******************************************************************************/
10 #ifndef MA_INPUT_H
11 #define MA_INPUT_H
12 
22 #include "maMesh.h"
23 #include "maSize.h"
24 #include "maSolutionTransfer.h"
25 
26 namespace ma {
27 
28 class ShapeHandler;
29 class Adapt;
30 
31 typedef ShapeHandler* (*ShapeHandlerFunction)(Adapt* a);
32 
34 class Input
35 {
36  public:
37  ~Input();
38  Mesh* mesh;
39  SizeField* sizeField;
40  bool ownsSizeField;
41  SolutionTransfer* solutionTransfer;
42  bool ownsSolutionTransfer;
43  ShapeHandlerFunction shapeHandler;
45  int maximumIterations;
47  bool shouldCoarsen;
50  bool shouldSnap;
53  bool shouldTransferParametric;
56  bool shouldTransferToClosestPoint;
58  bool shouldHandleMatching;
60  bool shouldFixShape;
62  bool shouldForceAdaptation;
64  bool shouldPrintQuality;
67  double goodQuality;
70  double shouldCheckQualityForDoubleSplits;
74  double validQuality;
76  double maximumImbalance;
78  bool shouldRunPreZoltan;
80  bool shouldRunPreZoltanRib;
82  bool shouldRunPreParma;
84  bool shouldRunMidZoltan;
86  bool shouldRunMidParma;
88  bool shouldRunPostZoltan;
90  bool shouldRunPostZoltanRib;
92  bool shouldRunPostParma;
95  double maximumEdgeRatio;
97  bool shouldTurnLayerToTets;
99  bool shouldCleanupLayer;
101  bool shouldRefineLayer;
103  bool shouldCoarsenLayer;
105  bool splitAllLayerEdges;
109  const char* userDefinedLayerTagName;
111  const char* debugFolder;
112 };
113 
118 Input* configure(
119  Mesh* m,
120  AnisotropicFunction* f,
121  SolutionTransfer* s=0,
122  bool logInterpolation=true);
126 Input* configure(
127  Mesh* m,
128  IsotropicFunction* f,
129  SolutionTransfer* s=0);
138 Input* configure(
139  Mesh* m,
140  apf::Field* sizes,
141  apf::Field* frames,
142  SolutionTransfer* s=0,
143  bool logInterpolation=true);
148 Input* configure(
149  Mesh* m,
150  apf::Field* size,
151  SolutionTransfer* s=0);
152 
154 Input* configureUniformRefine(Mesh* m, int n=1, SolutionTransfer* s=0);
156 Input* configureMatching(Mesh* m, int n=1, SolutionTransfer* s=0);
158 Input* configureIdentity(Mesh* m, SizeField* f=0, SolutionTransfer* s=0);
159 
161 void validateInput(Input* in);
162 
163 }
164 
165 #endif
ma::Input::userDefinedLayerTagName
const char * userDefinedLayerTagName
the name of the (user defined) INT tag specifying the boundary layer elements. Use the value of 0 for...
Definition: maInput.h:109
ma::Input::shouldTurnLayerToTets
bool shouldTurnLayerToTets
whether to tetrahedronize the boundary layer (default false)
Definition: maInput.h:97
ma::SolutionTransfer
user-defined solution transfer base
Definition: maSolutionTransfer.h:27
ma::validateInput
void validateInput(Input *in)
used internally, but users can call this if they want
maSize.h
MeshAdapt Size Fields.
ma::configureUniformRefine
Input * configureUniformRefine(Mesh *m, int n=1, SolutionTransfer *s=0)
generate a uniform refinement configuration
ma::Input::shouldCheckQualityForDoubleSplits
double shouldCheckQualityForDoubleSplits
whether to check the quality of split elems in DoubleSplitsCollapse (default false) ...
Definition: maInput.h:70
ma::AnisotropicFunction
User-defined Anisotropic size function.
Definition: maSize.h:72
ma::Input::splitAllLayerEdges
bool splitAllLayerEdges
set to true during UR to get splits in the normal direction
Definition: maInput.h:105
ma::Input::shouldRunPreZoltanRib
bool shouldRunPreZoltanRib
whether to run zoltan predictive load balancing using RIB (default false)
Definition: maInput.h:80
ma::Input::shouldCoarsenLayer
bool shouldCoarsenLayer
whether to allow layer coarsening (default false)
Definition: maInput.h:103
ma::Input::shouldRunPreZoltan
bool shouldRunPreZoltan
whether to run zoltan predictive load balancing (default false)
Definition: maInput.h:78
ma::Input::maximumEdgeRatio
double maximumEdgeRatio
the ratio between longest and shortest edges that differentiates a "short edge" element from a "large...
Definition: maInput.h:95
ma::Input::shouldTransferToClosestPoint
bool shouldTransferToClosestPoint
whether to transfer to the parametric coords of the closest point
Definition: maInput.h:56
ma::Input::shouldHandleMatching
bool shouldHandleMatching
whether to update matched entity info (limited support)
Definition: maInput.h:58
ma::Input::shouldForceAdaptation
bool shouldForceAdaptation
whether to adapt if it makes local quality worse (default false)
Definition: maInput.h:62
ma::Input::shouldPrintQuality
bool shouldPrintQuality
whether to print the worst shape quality
Definition: maInput.h:64
ma::Input::goodQuality
double goodQuality
minimum desired mean ratio cubed for simplex elements
Definition: maInput.h:67
ma::Input::maximumIterations
int maximumIterations
number of refine/coarsen iterations to run (default 3)
Definition: maInput.h:45
ma::Input::shouldRunPostZoltan
bool shouldRunPostZoltan
whether to run zoltan after adapting (default false)
Definition: maInput.h:88
ma::Input
User configuration for a MeshAdapt run.
Definition: maInput.h:34
ma::Input::shouldRunPostZoltanRib
bool shouldRunPostZoltanRib
whether to run zoltan RIB after adapting (default false)
Definition: maInput.h:90
maSolutionTransfer.h
MeshAdapt solution transfer interface.
ma::Input::shouldRunPostParma
bool shouldRunPostParma
whether to run parma after adapting (default false)
Definition: maInput.h:92
ma::Input::shouldFixShape
bool shouldFixShape
whether to run shape correction (default true)
Definition: maInput.h:60
ma::Input::shouldRunPreParma
bool shouldRunPreParma
whether to run parma predictive load balancing (default false)
Definition: maInput.h:82
ma::IsotropicFunction
User-defined Isotropic size function.
Definition: maSize.h:84
ma::configureIdentity
Input * configureIdentity(Mesh *m, SizeField *f=0, SolutionTransfer *s=0)
generate a no-op configuration
ma::Input::shouldCoarsen
bool shouldCoarsen
whether to perform the collapse step
Definition: maInput.h:47
ma::Input::shouldCleanupLayer
bool shouldCleanupLayer
whether to tetrahedronize abnormal pyramids (default false)
Definition: maInput.h:99
maMesh.h
mesh functions for MeshAdapt
ma::Input::shouldRefineLayer
bool shouldRefineLayer
whether to allow layer refinement (default false)
Definition: maInput.h:101
ma::Input::maximumImbalance
double maximumImbalance
imbalance target for all load balancing tools (default 1.10)
Definition: maInput.h:76
ma::Input::debugFolder
const char * debugFolder
this a folder that debugging meshes will be written to, if provided!
Definition: maInput.h:111
ma::Input::shouldSnap
bool shouldSnap
whether to snap new vertices to the model surface
Definition: maInput.h:50
apf::Mesh2
Extended mesh interface for modification.
Definition: apfMesh2.h:29
ma::Input::validQuality
double validQuality
minimum valid mean ratio cubed for simplex elements (default 1e-10)
Definition: maInput.h:74
ma::Input::shouldTransferParametric
bool shouldTransferParametric
whether to transfer parametric coordinates
Definition: maInput.h:53
ma::configureMatching
Input * configureMatching(Mesh *m, int n=1, SolutionTransfer *s=0)
generate a matched uniform refinement configuration
ma::configure
Input * configure(Mesh *m, AnisotropicFunction *f, SolutionTransfer *s=0, bool logInterpolation=true)
generate a configuration based on an anisotropic function.
ma::Input::shouldRunMidParma
bool shouldRunMidParma
whether to run parma during adaptation (default false)
Definition: maInput.h:86
ma::Input::shouldRunMidZoltan
bool shouldRunMidZoltan
whether to run zoltan during adaptation (default false)
Definition: maInput.h:84
Generated for SCOREC core by doxygen 1.8.5