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, const unsigned int & density, const unsigned int & temp) const;
42 
44  virtual void update();
45 
51  virtual void setMaterialNames(std::vector<std::string> names) { _material_names = names; }
52 
57  unsigned int nBins() const;
58 
64  virtual unsigned int getTemperatureBin(const Elem * const elem) const;
65 
71  virtual unsigned int getDensityBin(const Elem * const elem) const;
72 
78  virtual unsigned int getSubdomainBin(const Elem * const elem) const
79  {
80  return _blocks.at(elem->subdomain_id());
81  }
82 
87  void setUseDisplacedMesh(const bool & use);
88 
93  virtual void setScaling(const Real & scale) { _scaling = scale; }
94 
99  virtual void setVerbosity(const bool & verbose) { _verbose = verbose; }
100 
105  virtual void makeDependentOnExternalAction() { _standalone = false; }
106 
113  unsigned int getAuxiliaryVariableNumber(const std::string & name,
114  const std::string & param_name) const;
115 
117  void reset();
118 
126  virtual unsigned int getBin(const unsigned int & temp_bin,
127  const unsigned int & density_bin,
128  const unsigned int & subdomain_bin) const;
129 
134  virtual const bool & hasGraveyard() const { return _build_graveyard; }
135 
140  void setGraveyard(bool build);
141 
147  virtual unsigned int nDensityBins() const { return _n_density_bins; }
148 
153  virtual bool hasDensitySkinning() const { return _bin_by_density; }
154 
159  const std::shared_ptr<moab::Interface> & moabPtr() const { return _moab; }
160 
161 protected:
162  std::unique_ptr<NumericVector<Number>> _serialized_solution;
163 
165  std::shared_ptr<moab::Interface> _moab;
166 
168  bool _verbose;
169 
171  const std::string & _temperature_name;
172 
174  const Real & _temperature_min;
175 
177  const Real & _temperature_max;
178 
180  const unsigned int & _n_temperature_bins;
181 
184 
186  const bool _bin_by_density;
187 
190  std::vector<std::string> _material_names;
191 
193  const Real & _faceting_tol;
194 
196  const Real & _geom_tol;
197 
200 
203 
205  const bool & _output_skins;
206 
208  const bool & _output_full;
209 
215 
218 
221 
224 
226  Real _scaling;
227 
229  unsigned int _n_write;
230 
233 
235  enum Sense
236  {
237  BACKWARDS = -1,
239  };
240 
242  struct VolData
243  {
244  moab::EntityHandle vol;
246  };
247 
249  MooseMesh & getMooseMesh();
256  void createMOABElems();
257 
259  virtual void createTags();
260 
267  void createGroup(const unsigned int & id, const std::string & name, moab::EntityHandle & group_set);
268 
270  void createVol(const unsigned int & id, moab::EntityHandle & volume_set, moab::EntityHandle group_set);
271 
273  void createSurf(const unsigned int & id,
274  moab::EntityHandle & surface_set,
275  moab::Range & faces,
276  const std::vector<VolData> & voldata);
277 
279  void createSurfaces(moab::Range & reversed, VolData & voldata, unsigned int & surf_id);
280 
284  void createSurfaceFromBox(const BoundingBox & box,
285  const VolData & voldata,
286  unsigned int & surf_id,
287  bool normalout,
288  const Real & factor);
289 
296  std::vector<moab::EntityHandle> createNodesFromBox(const BoundingBox & box,
297  const Real & factor) const;
298 
300  void createCornerTris(const std::vector<moab::EntityHandle> & verts,
301  unsigned int corner,
302  unsigned int v1,
303  unsigned int v2,
304  unsigned int v3,
305  bool normalout,
306  moab::Range & surface_tris);
307 
309  moab::EntityHandle createTri(const std::vector<moab::EntityHandle> & vertices,
310  unsigned int v1,
311  unsigned int v2,
312  unsigned int v3);
313 
315  void updateSurfData(moab::EntityHandle surface_set, const VolData & data);
316 
318  void
319  setTags(moab::EntityHandle ent, std::string name, std::string category, unsigned int id, int dim);
320 
322  void setTagData(moab::Tag tag, moab::EntityHandle ent, std::string data, unsigned int SIZE);
323 
325  void setTagData(moab::Tag tag, moab::EntityHandle ent, void * data);
326 
331  const std::vector<std::vector<unsigned int>> & getTetSets(ElemType type) const;
332 
345  void buildGraveyard(unsigned int & vol_id, unsigned int & surf_id);
346 
348  virtual void findBlocks();
349 
351  virtual void sortElemsByResults();
352 
354  void findSurfaces();
355 
358  void groupLocalElems(std::set<dof_id_type> elems, std::vector<moab::Range> & localElems);
359 
361  bool resetMOAB();
362 
364  void findSurface(const moab::Range & region,
365  moab::EntityHandle group,
366  unsigned int & vol_id,
367  unsigned int & surf_id,
368  moab::EntityHandle & volume_set);
369 
371  virtual void write();
372 
374  std::unique_ptr<moab::Skinner> skinner;
375 
377  std::unique_ptr<moab::GeomTopoTool> gtt;
378 
380  std::map<dof_id_type, std::vector<moab::EntityHandle>> _id_to_elem_handles;
381 
383  moab::EntityHandle offset;
384 
386  std::string _density_name;
387 
390 
393 
396 
398  unsigned int _n_density_bins;
399 
401  unsigned int _n_block_bins;
402 
404  std::vector<std::set<dof_id_type>> _elem_bins;
405 
407  std::map<SubdomainID, unsigned int> _blocks;
408 
410  moab::EntityHandle _all_tets;
411 
413  std::map<moab::EntityHandle, std::vector<VolData>> surfsToVols;
414 
417 
419  moab::Tag id_tag;
420 
422  moab::Tag faceting_tol_tag;
423 
426 
428  moab::Tag category_tag;
429 
431  moab::Tag name_tag;
432 
434  std::vector<Real> _temperature_bin_bounds;
435 
437  std::vector<Real> _density_bin_bounds;
438 
440  std::vector<std::vector<unsigned int>> _tet4_nodes;
441 
446  std::vector<std::vector<unsigned int>> _tet10_nodes;
447 
449  unsigned int _temperature_var_num;
450 
452  unsigned int _density_var_num;
453 
455  const unsigned int NODES_PER_MOAB_TET = 4;
456 
458  const Real BIN_TOLERANCE = 1e-6;
459 };
const Real _temperature_bin_width
Temperature bin width.
Definition: MoabSkinner.h:183
std::vector< std::string > _material_names
Definition: MoabSkinner.h:190
virtual void makeDependentOnExternalAction()
Definition: MoabSkinner.h:105
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:165
const Real & _temperature_min
Lower bound of temperature bins.
Definition: MoabSkinner.h:174
unsigned int _density_var_num
Auxiliary variable number for density.
Definition: MoabSkinner.h:452
const Real & _temperature_max
Upper bound of temperature bins.
Definition: MoabSkinner.h:177
bool _standalone
Whether this class runs by itself, or is controlled by an external class.
Definition: MoabSkinner.h:232
std::map< moab::EntityHandle, std::vector< VolData > > surfsToVols
Save some topological data: map from surface handle to vol handle and sense.
Definition: MoabSkinner.h:413
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.
virtual void initialize() override
bool _verbose
Whether to print diagnostic information.
Definition: MoabSkinner.h:168
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:386
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:404
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:401
std::vector< Real > _density_bin_bounds
Bounds of the density bins.
Definition: MoabSkinner.h:437
unsigned int _n_density_bins
Number of density bins.
Definition: MoabSkinner.h:398
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:377
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:237
void groupLocalElems(std::set< dof_id_type > elems, std::vector< moab::Range > &localElems)
Real _density_bin_width
Density bin width.
Definition: MoabSkinner.h:395
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:93
const std::shared_ptr< moab::Interface > & moabPtr() const
Definition: MoabSkinner.h:159
moab::Tag name_tag
Tag for name of entity set.
Definition: MoabSkinner.h:431
virtual bool hasDensitySkinning() const
Definition: MoabSkinner.h:153
const std::string & _temperature_name
Name of the temperature variable.
Definition: MoabSkinner.h:171
moab::Tag geometry_dimension_tag
Tag for dimension for geometry.
Definition: MoabSkinner.h:416
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:217
virtual unsigned int nDensityBins() const
Definition: MoabSkinner.h:147
moab::Tag id_tag
Tag for entitiy set ID.
Definition: MoabSkinner.h:419
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:162
const bool & _output_skins
Whether to output the MOAB mesh skins to a .h5m file.
Definition: MoabSkinner.h:205
virtual void setVerbosity(const bool &verbose)
Definition: MoabSkinner.h:99
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:380
MooseMesh & getMooseMesh()
Moose mesh.
const Real & _graveyard_scale_outer
Multiplier on bounding box for outer surface of graveyard.
Definition: MoabSkinner.h:202
const bool & _output_full
Whether to output the MOAB mesh to a .h5m file.
Definition: MoabSkinner.h:208
std::unique_ptr< moab::Skinner > skinner
Moab skinner for finding temperature surfaces.
Definition: MoabSkinner.h:374
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:226
moab::Tag geometry_resabs_tag
Tag needed by DAGMC.
Definition: MoabSkinner.h:425
std::vector< std::vector< unsigned int > > _tet4_nodes
Node ordering for a TET4 MOAB element, based on libMesh node numberings.
Definition: MoabSkinner.h:440
Sense
Encode the whether the surface normal faces into or out of the volume.
Definition: MoabSkinner.h:235
void buildGraveyard(unsigned int &vol_id, unsigned int &surf_id)
Build a graveyard volume around the domain.
std::vector< moab::EntityHandle > createNodesFromBox(const BoundingBox &box, const Real &factor) const
moab::Tag faceting_tol_tag
Tag for faceting tolerance.
Definition: MoabSkinner.h:422
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:229
moab::EntityHandle offset
Save the first tet entity handle.
Definition: MoabSkinner.h:383
virtual unsigned int getSubdomainBin(const Elem *const elem) const
Definition: MoabSkinner.h:78
Sense sense
Definition: MoabSkinner.h:245
moab::EntityHandle _all_tets
Entity handle to represent the set of all tets.
Definition: MoabSkinner.h:410
const Real & _graveyard_scale_inner
Multiplier on bounding box for inner surface of graveyard.
Definition: MoabSkinner.h:199
virtual moab::ErrorCode check(const moab::ErrorCode input) const
Definition: MoabSkinner.h:238
bool _use_displaced
Whether the skinned mesh should be generated from a displaced mesh.
Definition: MoabSkinner.h:223
std::map< SubdomainID, unsigned int > _blocks
Blocks in the [Mesh].
Definition: MoabSkinner.h:407
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:180
virtual void setMaterialNames(std::vector< std::string > names)
Definition: MoabSkinner.h:51
bool resetMOAB()
Clear MOAB entity sets.
const Real & _geom_tol
Geometry tolerence needed by DAGMC.
Definition: MoabSkinner.h:196
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:392
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:244
std::vector< std::vector< unsigned int > > _tet10_nodes
Definition: MoabSkinner.h:446
bool _build_graveyard
Definition: MoabSkinner.h:214
std::string _implicit_complement_group_name
OpenMC material name or ID which will be assigned to the implicit complement.
Definition: MoabSkinner.h:220
moab::Tag category_tag
Tag for type of entity set.
Definition: MoabSkinner.h:428
const bool _bin_by_density
Whether elements are binned by density (in addition to temperature and block)
Definition: MoabSkinner.h:186
const Real BIN_TOLERANCE
Tolerance to use for comparing values to bin bounds.
Definition: MoabSkinner.h:458
const Real & _faceting_tol
Faceting tolerence needed by DAGMC.
Definition: MoabSkinner.h:193
void setGraveyard(bool build)
virtual void execute() override
virtual const bool & hasGraveyard() const
Definition: MoabSkinner.h:134
Encode MOAB information about volumes needed when creating surfaces.
Definition: MoabSkinner.h:242
Real _density_min
Lower bound of density bins.
Definition: MoabSkinner.h:389
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:455
std::vector< Real > _temperature_bin_bounds
Bounds of the temperature bins.
Definition: MoabSkinner.h:434
virtual void createTags()
Helper method to create MOAB tags.
unsigned int _temperature_var_num
Auxiliary variable number for temperature.
Definition: MoabSkinner.h:449