Cardinal
MoabSkinner.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include "GeneralUserObject.h"
4 #include "MaterialBase.h"
5 #include "MooseMesh.h"
6 
7 #include "moab/Core.hpp"
8 #include "moab/Skinner.hpp"
9 #include "moab/GeomTopoTool.hpp"
10 #include "MBTagConventions.hpp"
11 
19 class MoabSkinner : public GeneralUserObject
20 {
21 public:
22  MoabSkinner(const InputParameters & parameters);
23 
24  static InputParameters validParams();
25 
26  virtual void execute() override;
27 
28  virtual void initialize() override;
29 
30  virtual void finalize() override;
31 
32  virtual void threadJoin(const UserObject & /* uo */) override {}
33 
39  virtual moab::ErrorCode check(const moab::ErrorCode input) const;
40 
41  std::string materialName(const unsigned int & block,
42  const unsigned int & density,
43  const unsigned int & temp) const;
44 
46  virtual void update();
47 
53  virtual void setMaterialNames(std::vector<std::string> names) { _material_names = names; }
54 
59  unsigned int nBins() const;
60 
66  virtual unsigned int getTemperatureBin(const Elem * const elem) const;
67 
73  virtual unsigned int getDensityBin(const Elem * const elem) const;
74 
80  virtual unsigned int getSubdomainBin(const Elem * const elem) const
81  {
82  return _blocks.at(elem->subdomain_id());
83  }
84 
89  void setUseDisplacedMesh(const bool & use);
90 
95  virtual void setScaling(const Real & scale) { _scaling = scale; }
96 
101  virtual void setVerbosity(const bool & verbose) { _verbose = verbose; }
102 
107  virtual void makeDependentOnExternalAction() { _standalone = false; }
108 
115  unsigned int getAuxiliaryVariableNumber(const std::string & name,
116  const std::string & param_name) const;
117 
119  void reset();
120 
128  virtual unsigned int getBin(const unsigned int & temp_bin,
129  const unsigned int & density_bin,
130  const unsigned int & subdomain_bin) const;
131 
136  virtual const bool & hasGraveyard() const { return _build_graveyard; }
137 
142  void setGraveyard(bool build);
143 
149  virtual unsigned int nDensityBins() const { return _n_density_bins; }
150 
155  virtual bool hasDensitySkinning() const { return _bin_by_density; }
156 
161  const std::shared_ptr<moab::Interface> & moabPtr() const { return _moab; }
162 
163 protected:
164  std::unique_ptr<NumericVector<Number>> _serialized_solution;
165 
167  std::shared_ptr<moab::Interface> _moab;
168 
170  bool _verbose;
171 
173  const std::string & _temperature_name;
174 
176  const Real & _temperature_min;
177 
179  const Real & _temperature_max;
180 
182  const unsigned int & _n_temperature_bins;
183 
186 
188  const bool _bin_by_density;
189 
192  std::vector<std::string> _material_names;
193 
195  const Real & _faceting_tol;
196 
198  const Real & _geom_tol;
199 
202 
205 
207  const bool & _output_skins;
208 
210  const bool & _output_full;
211 
217 
220 
223 
226 
228  Real _scaling;
229 
231  unsigned int _n_write;
232 
235 
238 
240  std::unique_ptr<MeshBase> _tet_mesh;
241 
243  enum Sense
244  {
245  BACKWARDS = -1,
247  };
248 
250  struct VolData
251  {
252  moab::EntityHandle vol;
254  };
255 
257  MooseMesh & getMooseMesh();
258 
264  MeshBase & getDAGMCGeometryMesh();
265 
267  void buildTetMesh();
268 
276  void createMOABElems();
277 
279  virtual void createTags();
280 
287  void
288  createGroup(const unsigned int & id, const std::string & name, moab::EntityHandle & group_set);
289 
291  void
292  createVol(const unsigned int & id, moab::EntityHandle & volume_set, moab::EntityHandle group_set);
293 
295  void createSurf(const unsigned int & id,
296  moab::EntityHandle & surface_set,
297  moab::Range & faces,
298  const std::vector<VolData> & voldata);
299 
301  void createSurfaces(moab::Range & reversed, VolData & voldata, unsigned int & surf_id);
302 
306  void createSurfaceFromBox(const BoundingBox & box,
307  const VolData & voldata,
308  unsigned int & surf_id,
309  bool normalout,
310  const Real & factor);
311 
318  std::vector<moab::EntityHandle> createNodesFromBox(const BoundingBox & box,
319  const Real & factor) const;
320 
322  void createCornerTris(const std::vector<moab::EntityHandle> & verts,
323  unsigned int corner,
324  unsigned int v1,
325  unsigned int v2,
326  unsigned int v3,
327  bool normalout,
328  moab::Range & surface_tris);
329 
331  moab::EntityHandle createTri(const std::vector<moab::EntityHandle> & vertices,
332  unsigned int v1,
333  unsigned int v2,
334  unsigned int v3);
335 
337  void updateSurfData(moab::EntityHandle surface_set, const VolData & data);
338 
340  void
341  setTags(moab::EntityHandle ent, std::string name, std::string category, unsigned int id, int dim);
342 
344  void setTagData(moab::Tag tag, moab::EntityHandle ent, std::string data, unsigned int SIZE);
345 
347  void setTagData(moab::Tag tag, moab::EntityHandle ent, void * data);
348 
353  const std::vector<std::vector<unsigned int>> & getTetSets(ElemType type) const;
354 
367  void buildGraveyard(unsigned int & vol_id, unsigned int & surf_id);
368 
370  virtual void findBlocks();
371 
373  virtual void sortElemsByResults();
374 
376  void findSurfaces();
377 
380  void groupLocalElems(std::set<dof_id_type> elems, std::vector<moab::Range> & localElems);
381 
383  bool resetMOAB();
384 
386  void findSurface(const moab::Range & region,
387  moab::EntityHandle group,
388  unsigned int & vol_id,
389  unsigned int & surf_id,
390  moab::EntityHandle & volume_set);
391 
393  virtual void write();
394 
396  std::unique_ptr<moab::Skinner> skinner;
397 
399  std::unique_ptr<moab::GeomTopoTool> gtt;
400 
402  std::map<dof_id_type, std::vector<moab::EntityHandle>> _id_to_elem_handles;
403 
405  moab::EntityHandle offset;
406 
408  std::string _density_name;
409 
412 
415 
418 
420  unsigned int _n_density_bins;
421 
423  unsigned int _n_block_bins;
424 
426  std::vector<std::set<dof_id_type>> _elem_bins;
427 
429  std::map<SubdomainID, unsigned int> _blocks;
430 
432  moab::EntityHandle _all_tets;
433 
435  std::map<moab::EntityHandle, std::vector<VolData>> surfsToVols;
436 
439 
441  moab::Tag id_tag;
442 
444  moab::Tag faceting_tol_tag;
445 
448 
450  moab::Tag category_tag;
451 
453  moab::Tag name_tag;
454 
456  std::vector<Real> _temperature_bin_bounds;
457 
459  std::vector<Real> _density_bin_bounds;
460 
462  std::vector<std::vector<unsigned int>> _tet4_nodes;
463 
468  std::vector<std::vector<unsigned int>> _tet10_nodes;
469 
471  unsigned int _temperature_var_num;
472 
474  unsigned int _density_var_num;
475 
477  const unsigned int NODES_PER_MOAB_TET = 4;
478 
480  const Real BIN_TOLERANCE = 1e-6;
481 };
const Real _temperature_bin_width
Temperature bin width.
Definition: MoabSkinner.h:185
std::vector< std::string > _material_names
Definition: MoabSkinner.h:192
virtual void makeDependentOnExternalAction()
Definition: MoabSkinner.h:107
void createSurfaces(moab::Range &reversed, VolData &voldata, unsigned int &surf_id)
Helper method to create MOAB surfaces with no overlaps.
const std::vector< std::vector< unsigned int > > & getTetSets(ElemType type) const
std::shared_ptr< moab::Interface > _moab
MOAB interface.
Definition: MoabSkinner.h:167
const Real & _temperature_min
Lower bound of temperature bins.
Definition: MoabSkinner.h:176
unsigned int _density_var_num
Auxiliary variable number for density.
Definition: MoabSkinner.h:474
bool _tet_mesh_built
True when buildTetMesh() is called.
Definition: MoabSkinner.h:237
const Real & _temperature_max
Upper bound of temperature bins.
Definition: MoabSkinner.h:179
bool _standalone
Whether this class runs by itself, or is controlled by an external class.
Definition: MoabSkinner.h:234
std::map< moab::EntityHandle, std::vector< VolData > > surfsToVols
Save some topological data: map from surface handle to vol handle and sense.
Definition: MoabSkinner.h:435
virtual void write()
Write MOAB volume and/or skin meshes to file.
static InputParameters validParams()
std::string materialName(const unsigned int &block, const unsigned int &density, const unsigned int &temp) const
virtual unsigned int getTemperatureBin(const Elem *const elem) const
void findSurface(const moab::Range &region, moab::EntityHandle group, unsigned int &vol_id, unsigned int &surf_id, moab::EntityHandle &volume_set)
Find the surfaces for the provided range and add to group.
MeshBase & getDAGMCGeometryMesh()
virtual void initialize() override
bool _verbose
Whether to print diagnostic information.
Definition: MoabSkinner.h:170
void createSurfaceFromBox(const BoundingBox &box, const VolData &voldata, unsigned int &surf_id, bool normalout, const Real &factor)
std::string _density_name
Name of the MOOSE variable containing the density.
Definition: MoabSkinner.h:408
virtual void update()
Perform the skinning operation.
std::vector< std::set< dof_id_type > > _elem_bins
Mapping from total bin ID to a set of elements sorted into that bin.
Definition: MoabSkinner.h:426
void createSurf(const unsigned int &id, moab::EntityHandle &surface_set, moab::Range &faces, const std::vector< VolData > &voldata)
Helper method to create MOAB surface entity set.
void findSurfaces()
Group the binned elems into local temperature regions and find their surfaces.
unsigned int _n_block_bins
Number of block bins.
Definition: MoabSkinner.h:423
std::vector< Real > _density_bin_bounds
Bounds of the density bins.
Definition: MoabSkinner.h:459
unsigned int _n_density_bins
Number of density bins.
Definition: MoabSkinner.h:420
virtual void threadJoin(const UserObject &) override
Definition: MoabSkinner.h:32
virtual void finalize() override
std::unique_ptr< moab::GeomTopoTool > gtt
Topology tool for setting surface sense.
Definition: MoabSkinner.h:399
MoabSkinner(const InputParameters &parameters)
void setTagData(moab::Tag tag, moab::EntityHandle ent, std::string data, unsigned int SIZE)
Helper function to wrap moab::tag_set_data for a string.
unsigned int nBins() const
Definition: MoabSkinner.h:245
void groupLocalElems(std::set< dof_id_type > elems, std::vector< moab::Range > &localElems)
Real _density_bin_width
Density bin width.
Definition: MoabSkinner.h:417
void createMOABElems()
void setUseDisplacedMesh(const bool &use)
moab::EntityHandle createTri(const std::vector< moab::EntityHandle > &vertices, unsigned int v1, unsigned int v2, unsigned int v3)
Create MOAB tri surface element.
virtual unsigned int getBin(const unsigned int &temp_bin, const unsigned int &density_bin, const unsigned int &subdomain_bin) const
virtual void setScaling(const Real &scale)
Definition: MoabSkinner.h:95
const std::shared_ptr< moab::Interface > & moabPtr() const
Definition: MoabSkinner.h:161
moab::Tag name_tag
Tag for name of entity set.
Definition: MoabSkinner.h:453
virtual bool hasDensitySkinning() const
Definition: MoabSkinner.h:155
const std::string & _temperature_name
Name of the temperature variable.
Definition: MoabSkinner.h:173
moab::Tag geometry_dimension_tag
Tag for dimension for geometry.
Definition: MoabSkinner.h:438
void createGroup(const unsigned int &id, const std::string &name, moab::EntityHandle &group_set)
bool _set_implicit_complement_material
Whether to assign a material to the implicit complement region.
Definition: MoabSkinner.h:219
virtual unsigned int nDensityBins() const
Definition: MoabSkinner.h:149
moab::Tag id_tag
Tag for entitiy set ID.
Definition: MoabSkinner.h:441
Definition: CardinalEnums.h:233
unsigned int getAuxiliaryVariableNumber(const std::string &name, const std::string &param_name) const
std::unique_ptr< NumericVector< Number > > _serialized_solution
Definition: MoabSkinner.h:164
const bool & _output_skins
Whether to output the MOAB mesh skins to a .h5m file.
Definition: MoabSkinner.h:207
virtual void setVerbosity(const bool &verbose)
Definition: MoabSkinner.h:101
int dim()
std::map< dof_id_type, std::vector< moab::EntityHandle > > _id_to_elem_handles
Map from libmesh id to MOAB element entity handles.
Definition: MoabSkinner.h:402
MooseMesh & getMooseMesh()
Get the MooseMesh (displaced or not, depending on _use_displaced)
const Real & _graveyard_scale_outer
Multiplier on bounding box for outer surface of graveyard.
Definition: MoabSkinner.h:204
const bool & _output_full
Whether to output the MOAB mesh to a .h5m file.
Definition: MoabSkinner.h:210
std::unique_ptr< moab::Skinner > skinner
Moab skinner for finding temperature surfaces.
Definition: MoabSkinner.h:396
void createCornerTris(const std::vector< moab::EntityHandle > &verts, unsigned int corner, unsigned int v1, unsigned int v2, unsigned int v3, bool normalout, moab::Range &surface_tris)
Create 3 tri faces stemming from one corner of a cude (an open tetrahedron)
Real _scaling
Length multiplier to get from [Mesh] units into OpenMC's centimeters.
Definition: MoabSkinner.h:228
moab::Tag geometry_resabs_tag
Tag needed by DAGMC.
Definition: MoabSkinner.h:447
std::vector< std::vector< unsigned int > > _tet4_nodes
Node ordering for a TET4 MOAB element, based on libMesh node numberings.
Definition: MoabSkinner.h:462
Sense
Encode the whether the surface normal faces into or out of the volume.
Definition: MoabSkinner.h:243
void buildGraveyard(unsigned int &vol_id, unsigned int &surf_id)
Build a graveyard volume around the domain.
std::unique_ptr< MeshBase > _tet_mesh
TET4 clone of the MOOSE mesh. Present only when the source mesh contains non-tetrahedral elements....
Definition: MoabSkinner.h:240
std::vector< moab::EntityHandle > createNodesFromBox(const BoundingBox &box, const Real &factor) const
moab::Tag faceting_tol_tag
Tag for faceting tolerance.
Definition: MoabSkinner.h:444
void createVol(const unsigned int &id, moab::EntityHandle &volume_set, moab::EntityHandle group_set)
Helper method to create MOAB volume entity set.
unsigned int _n_write
Count number of times output files have been written.
Definition: MoabSkinner.h:231
moab::EntityHandle offset
Save the first tet entity handle.
Definition: MoabSkinner.h:405
virtual unsigned int getSubdomainBin(const Elem *const elem) const
Definition: MoabSkinner.h:80
Sense sense
Definition: MoabSkinner.h:253
moab::EntityHandle _all_tets
Entity handle to represent the set of all tets.
Definition: MoabSkinner.h:432
const Real & _graveyard_scale_inner
Multiplier on bounding box for inner surface of graveyard.
Definition: MoabSkinner.h:201
virtual moab::ErrorCode check(const moab::ErrorCode input) const
Definition: MoabSkinner.h:246
bool _use_displaced
Whether the skinned mesh should be generated from a displaced mesh.
Definition: MoabSkinner.h:225
std::map< SubdomainID, unsigned int > _blocks
Blocks in the [Mesh].
Definition: MoabSkinner.h:429
virtual void sortElemsByResults()
Sort all the elements in the [Mesh] into bins for temperature, density, and subdomain.
const unsigned int & _n_temperature_bins
Number of temperature bins.
Definition: MoabSkinner.h:182
virtual void setMaterialNames(std::vector< std::string > names)
Definition: MoabSkinner.h:53
bool resetMOAB()
Clear MOAB entity sets.
const Real & _geom_tol
Geometry tolerence needed by DAGMC.
Definition: MoabSkinner.h:198
void setTags(moab::EntityHandle ent, std::string name, std::string category, unsigned int id, int dim)
Generic method to set the tags that DAGMC requires.
virtual unsigned int getDensityBin(const Elem *const elem) const
Real _density_max
Upper bound of density bins.
Definition: MoabSkinner.h:414
Skins the [Mesh] according to individual bins for temperature, density, and subdomain ID.
Definition: MoabSkinner.h:19
virtual void findBlocks()
Store a mapping from [Mesh] subdomain IDs to an index, to be used for binning by block ID.
moab::EntityHandle vol
Definition: MoabSkinner.h:252
std::vector< std::vector< unsigned int > > _tet10_nodes
Definition: MoabSkinner.h:468
bool _build_graveyard
Definition: MoabSkinner.h:216
std::string _implicit_complement_group_name
OpenMC material name or ID which will be assigned to the implicit complement.
Definition: MoabSkinner.h:222
void buildTetMesh()
If the mesh has non-tetrahedral elements, clone it into _tet_mesh and convert to all-TET4.
moab::Tag category_tag
Tag for type of entity set.
Definition: MoabSkinner.h:450
const bool _bin_by_density
Whether elements are binned by density (in addition to temperature and block)
Definition: MoabSkinner.h:188
const Real BIN_TOLERANCE
Tolerance to use for comparing values to bin bounds.
Definition: MoabSkinner.h:480
const Real & _faceting_tol
Faceting tolerence needed by DAGMC.
Definition: MoabSkinner.h:195
void setGraveyard(bool build)
virtual void execute() override
virtual const bool & hasGraveyard() const
Definition: MoabSkinner.h:136
Encode MOAB information about volumes needed when creating surfaces.
Definition: MoabSkinner.h:250
Real _density_min
Lower bound of density bins.
Definition: MoabSkinner.h:411
void updateSurfData(moab::EntityHandle surface_set, const VolData &data)
Add parent-child metadata relating a surface to its volume.
void reset()
Clear mesh data.
const unsigned int NODES_PER_MOAB_TET
Number of nodes per MOAB tet (which are first order, so TET4)
Definition: MoabSkinner.h:477
std::vector< Real > _temperature_bin_bounds
Bounds of the temperature bins.
Definition: MoabSkinner.h:456
virtual void createTags()
Helper method to create MOAB tags.
unsigned int _temperature_var_num
Auxiliary variable number for temperature.
Definition: MoabSkinner.h:471