Cardinal
Loading...
Searching...
No Matches
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
19class MoabSkinner : public GeneralUserObject
20{
21public:
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
54 virtual void setMaterialNames(std::vector<std::string> names) { _material_names = names; }
55
60 unsigned int nBins() const;
61
67 virtual unsigned int getTemperatureBin(const Elem * const elem) const;
68
74 virtual unsigned int getDensityBin(const Elem * const elem) const;
75
81 virtual unsigned int getSubdomainBin(const Elem * const elem) const
82 {
83 return _blocks.at(elem->subdomain_id());
84 }
85
90 void setUseDisplacedMesh(const bool & use);
91
96 virtual void setScaling(const Real & scale) { _scaling = scale; }
97
102 virtual void setVerbosity(const bool & verbose) { _verbose = verbose; }
103
108 virtual void makeDependentOnExternalAction() { _standalone = false; }
109
116 unsigned int getAuxiliaryVariableNumber(const std::string & name,
117 const std::string & param_name) const;
118
120 void reset();
121
129 virtual unsigned int getBin(const unsigned int & temp_bin,
130 const unsigned int & density_bin,
131 const unsigned int & subdomain_bin) const;
132
137 virtual const bool & hasGraveyard() const { return _build_graveyard; }
138
143 void setGraveyard(bool build);
144
150 virtual unsigned int nDensityBins() const { return _n_density_bins; }
151
156 virtual bool hasDensitySkinning() const { return _bin_by_density; }
157
162 const std::shared_ptr<moab::Interface> & moabPtr() const { return _moab; }
163
164protected:
167 {
169 Vacuum,
171 };
172
173 std::unique_ptr<NumericVector<Number>> _serialized_solution;
174
176 std::shared_ptr<moab::Interface> _moab;
177
180
182 const std::string & _temperature_name;
183
185 const Real & _temperature_min;
186
188 const Real & _temperature_max;
189
191 const unsigned int & _n_temperature_bins;
192
195
197 const bool _bin_by_density;
198
201 std::vector<std::string> _material_names;
202
204 const Real & _faceting_tol;
205
207 const Real & _geom_tol;
208
211
214
216 const bool & _output_skins;
217
219 const bool & _output_full;
220
226
229
232
235
238
240 unsigned int _n_write;
241
244
247
249 std::unique_ptr<MeshBase> _tet_mesh;
250
252 enum Sense
253 {
255 FORWARDS = 1
256 };
257
259 struct VolData
260 {
261 moab::EntityHandle vol;
263 };
264
266 MooseMesh & getMooseMesh();
267
274
277
286
288 virtual void createTags();
289
296 void
297 createGroup(const unsigned int & id, const std::string & name, moab::EntityHandle & group_set);
298
300 void
301 createVol(const unsigned int & id, moab::EntityHandle & volume_set, moab::EntityHandle group_set);
302
304 void createSurf(const unsigned int & id,
305 moab::EntityHandle & surface_set,
306 moab::Range & faces,
307 const std::vector<VolData> & voldata,
309
312 void createSurfaces(moab::Range & faces,
313 VolData & voldata,
314 unsigned int & surf_id,
316
320 void createSurfaceFromBox(const BoundingBox & box,
321 const VolData & voldata,
322 unsigned int & surf_id,
323 bool normalout,
324 const Real & factor);
325
332 std::vector<moab::EntityHandle> createNodesFromBox(const BoundingBox & box,
333 const Real & factor) const;
334
336 void createCornerTris(const std::vector<moab::EntityHandle> & verts,
337 unsigned int corner,
338 unsigned int v1,
339 unsigned int v2,
340 unsigned int v3,
341 bool normalout,
342 moab::Range & surface_tris);
343
345 moab::EntityHandle createTri(const std::vector<moab::EntityHandle> & vertices,
346 unsigned int v1,
347 unsigned int v2,
348 unsigned int v3);
349
351 void updateSurfData(moab::EntityHandle surface_set, const VolData & data);
352
354 void
355 setTags(moab::EntityHandle ent, std::string name, std::string category, unsigned int id, int dim);
356
358 void setTagData(moab::Tag tag, moab::EntityHandle ent, std::string data, unsigned int SIZE);
359
361 void setTagData(moab::Tag tag, moab::EntityHandle ent, void * data);
362
367 const std::vector<std::vector<unsigned int>> & getTetSets(ElemType type) const;
368
381 void buildGraveyard(unsigned int & vol_id, unsigned int & surf_id);
382
384 virtual void findBlocks();
385
387 virtual void sortElemsByResults();
388
391
399 std::set<BoundaryID> boundaryNamesToIDs(const std::vector<BoundaryName> & names,
400 const std::string & param_name);
401
404
414 const unsigned int side,
415 const libMesh::BoundaryInfo & boundary_info) const;
416
426 void splitSkinByBoundaryCondition(const moab::Range & region,
427 const moab::Range & skin,
428 moab::Range & transmission_tris,
429 moab::Range & vacuum_tris,
430 moab::Range & reflective_tris);
431
441 void createSurfacesFromSkin(const moab::Range & region,
442 moab::Range & skin,
443 VolData & voldata,
444 unsigned int & surf_id);
445
452 void recordBoundaryConditionSurface(moab::EntityHandle surface_set,
453 BoundaryConditionType bc_type);
454
460 BoundaryConditionType recordedBoundaryCondition(moab::EntityHandle surface_set) const;
461
465 unsigned int firstBoundaryConditionGroupID() const;
466
470
477
480 void groupLocalElems(std::set<dof_id_type> elems, std::vector<moab::Range> & localElems);
481
483 bool resetMOAB();
484
486 void findSurface(const moab::Range & region,
487 moab::EntityHandle group,
488 unsigned int & vol_id,
489 unsigned int & surf_id,
490 moab::EntityHandle & volume_set);
491
493 virtual void write();
494
496 std::unique_ptr<moab::Skinner> skinner;
497
499 std::unique_ptr<moab::GeomTopoTool> gtt;
500
502 std::map<dof_id_type, std::vector<moab::EntityHandle>> _id_to_elem_handles;
503
505 std::unordered_map<dof_id_type, moab::EntityHandle> _node_id_to_handle;
506
508 moab::EntityHandle offset;
509
511 std::string _density_name;
512
514 std::set<BoundaryID> _vacuum_bcs_surface_ids;
515
517 std::set<BoundaryID> _reflective_bcs_surface_ids;
518
521 std::map<moab::EntityHandle, BoundaryConditionType> _surface_bc_types;
522
524 std::unordered_map<moab::EntityHandle, dof_id_type> _elem_handle_to_id;
525
528
531
534
537
539 unsigned int _n_density_bins;
540
542 unsigned int _n_block_bins;
543
545 std::vector<std::set<dof_id_type>> _elem_bins;
546
548 std::map<SubdomainID, unsigned int> _blocks;
549
551 moab::EntityHandle _all_tets;
552
554 std::map<moab::EntityHandle, std::vector<VolData>> surfsToVols;
555
558
560 moab::Tag id_tag;
561
564
567
569 moab::Tag category_tag;
570
572 moab::Tag name_tag;
573
575 std::vector<Real> _temperature_bin_bounds;
576
578 std::vector<Real> _density_bin_bounds;
579
581 std::vector<std::vector<unsigned int>> _tet4_nodes;
582
587 std::vector<std::vector<unsigned int>> _tet10_nodes;
588
591
593 unsigned int _density_var_num;
594
596 const unsigned int NODES_PER_MOAB_TET = 4;
597
599 const Real BIN_TOLERANCE = 1e-6;
600
602 std::map<SubdomainID, std::string> _block_id_to_material_name;
603};
Skins the [Mesh] according to individual bins for temperature, density, and subdomain ID.
Definition MoabSkinner.h:20
void setGraveyard(bool build)
void buildTetMesh()
If the mesh has non-tetrahedral elements, clone it into _tet_mesh and convert to all-TET4.
const std::string & _temperature_name
Name of the temperature variable.
Definition MoabSkinner.h:182
void splitSkinByBoundaryCondition(const moab::Range &region, const moab::Range &skin, moab::Range &transmission_tris, moab::Range &vacuum_tris, moab::Range &reflective_tris)
void createGroup(const unsigned int &id, const std::string &name, moab::EntityHandle &group_set)
void createVol(const unsigned int &id, moab::EntityHandle &volume_set, moab::EntityHandle group_set)
Helper method to create MOAB volume entity set.
const bool & _output_skins
Whether to output the MOAB mesh skins to a .h5m file.
Definition MoabSkinner.h:216
std::vector< std::vector< unsigned int > > _tet4_nodes
Node ordering for a TET4 MOAB element, based on libMesh node numberings.
Definition MoabSkinner.h:581
virtual void initialize() override
const Real & _graveyard_scale_outer
Multiplier on bounding box for outer surface of graveyard.
Definition MoabSkinner.h:213
moab::Tag category_tag
Tag for type of entity set.
Definition MoabSkinner.h:569
bool _verbose
Whether to print diagnostic information.
Definition MoabSkinner.h:179
virtual void update()
Perform the skinning operation.
std::set< BoundaryID > _vacuum_bcs_surface_ids
Resolved vacuum BC sideset IDs (from 'vacuum_bcs_surfaces' input parameter)
Definition MoabSkinner.h:514
virtual void setScaling(const Real &scale)
Definition MoabSkinner.h:96
std::map< moab::EntityHandle, BoundaryConditionType > _surface_bc_types
Definition MoabSkinner.h:521
unsigned int firstBoundaryConditionGroupID() const
const Real & _temperature_min
Lower bound of temperature bins.
Definition MoabSkinner.h:185
bool _build_graveyard
Definition MoabSkinner.h:225
bool _standalone
Whether this class runs by itself, or is controlled by an external class.
Definition MoabSkinner.h:243
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.
moab::Tag faceting_tol_tag
Tag for faceting tolerance.
Definition MoabSkinner.h:563
Real _density_min
Lower bound of density bins.
Definition MoabSkinner.h:530
MeshBase & getDAGMCGeometryMesh()
virtual void finalize() override
unsigned int _n_density_bins
Number of density bins.
Definition MoabSkinner.h:539
virtual unsigned int getDensityBin(const Elem *const elem) const
const Real _temperature_bin_width
Temperature bin width.
Definition MoabSkinner.h:194
virtual moab::ErrorCode check(const moab::ErrorCode input) const
virtual void setVerbosity(const bool &verbose)
Definition MoabSkinner.h:102
virtual void setMaterialNames(std::vector< std::string > names)
Definition MoabSkinner.h:54
moab::EntityHandle createTri(const std::vector< moab::EntityHandle > &vertices, unsigned int v1, unsigned int v2, unsigned int v3)
Create MOAB tri surface element.
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:502
void createSurfaceFromBox(const BoundingBox &box, const VolData &voldata, unsigned int &surf_id, bool normalout, const Real &factor)
static InputParameters validParams()
const std::shared_ptr< moab::Interface > & moabPtr() const
Definition MoabSkinner.h:162
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:542
std::vector< std::vector< unsigned int > > _tet10_nodes
Definition MoabSkinner.h:587
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.
std::unique_ptr< moab::Skinner > skinner
Moab skinner for finding temperature surfaces.
Definition MoabSkinner.h:496
std::unordered_map< moab::EntityHandle, dof_id_type > _elem_handle_to_id
Reverse map from MOAB tet entity handle to libMesh element ID. Populated in createMOABElems()
Definition MoabSkinner.h:524
unsigned int _temperature_var_num
Auxiliary variable number for temperature.
Definition MoabSkinner.h:590
virtual void createTags()
Helper method to create MOAB tags.
std::shared_ptr< moab::Interface > _moab
MOAB interface.
Definition MoabSkinner.h:176
MoabSkinner(const InputParameters &parameters)
const unsigned int & _n_temperature_bins
Number of temperature bins.
Definition MoabSkinner.h:191
const Real & _geom_tol
Geometry tolerence needed by DAGMC.
Definition MoabSkinner.h:207
std::map< moab::EntityHandle, std::vector< VolData > > surfsToVols
Save some topological data: map from surface handle to vol handle and sense.
Definition MoabSkinner.h:554
virtual unsigned int getTemperatureBin(const Elem *const elem) const
virtual void threadJoin(const UserObject &) override
Definition MoabSkinner.h:32
void recordBoundaryConditionSurface(moab::EntityHandle surface_set, BoundaryConditionType bc_type)
std::unordered_map< dof_id_type, moab::EntityHandle > _node_id_to_handle
Map from libMesh id to MOAB vertex handles.
Definition MoabSkinner.h:505
const bool _bin_by_density
Whether elements are binned by density (in addition to temperature and block)
Definition MoabSkinner.h:197
std::vector< Real > _temperature_bin_bounds
Bounds of the temperature bins.
Definition MoabSkinner.h:575
std::vector< std::string > _material_names
Definition MoabSkinner.h:201
virtual void makeDependentOnExternalAction()
Definition MoabSkinner.h:108
std::unique_ptr< moab::GeomTopoTool > gtt
Topology tool for setting surface sense.
Definition MoabSkinner.h:499
virtual void write()
Write MOAB volume and/or skin meshes to file.
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:545
std::set< BoundaryID > _reflective_bcs_surface_ids
Resolved reflective BC sideset IDs (from 'reflective_bcs_surfaces' input parameter)
Definition MoabSkinner.h:517
bool _tet_mesh_built
True when buildTetMesh() is called.
Definition MoabSkinner.h:246
moab::Tag geometry_dimension_tag
Tag for dimension for geometry.
Definition MoabSkinner.h:557
MooseMesh & getMooseMesh()
Get the MooseMesh (displaced or not, depending on _use_displaced)
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)
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.
moab::EntityHandle _all_tets
Entity handle to represent the set of all tets.
Definition MoabSkinner.h:551
Sense
Encode the whether the surface normal faces into or out of the volume.
Definition MoabSkinner.h:253
@ FORWARDS
Definition MoabSkinner.h:255
@ BACKWARDS
Definition MoabSkinner.h:254
void reset()
Clear mesh data.
const bool & _output_full
Whether to output the MOAB mesh to a .h5m file.
Definition MoabSkinner.h:219
std::string materialName(const unsigned int &block, const unsigned int &density, const unsigned int &temp) const
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:249
BoundaryConditionType recordedBoundaryCondition(moab::EntityHandle surface_set) const
void setUseDisplacedMesh(const bool &use)
const std::vector< std::vector< unsigned int > > & getTetSets(ElemType type) const
moab::Tag name_tag
Tag for name of entity set.
Definition MoabSkinner.h:572
moab::Tag geometry_resabs_tag
Tag needed by DAGMC.
Definition MoabSkinner.h:566
unsigned int nBins() const
moab::EntityHandle offset
Save the first tet entity handle.
Definition MoabSkinner.h:508
virtual unsigned int getBin(const unsigned int &temp_bin, const unsigned int &density_bin, const unsigned int &subdomain_bin) const
virtual const bool & hasGraveyard() const
Definition MoabSkinner.h:137
std::set< BoundaryID > boundaryNamesToIDs(const std::vector< BoundaryName > &names, const std::string &param_name)
Real _density_max
Upper bound of density bins.
Definition MoabSkinner.h:533
const Real & _faceting_tol
Faceting tolerence needed by DAGMC.
Definition MoabSkinner.h:204
void checkBoundaryConditionOverlap() const
Error if the same sideset ID appears in both vacuum and reflective BC sets.
moab::Tag id_tag
Tag for entitiy set ID.
Definition MoabSkinner.h:560
unsigned int _density_var_num
Auxiliary variable number for density.
Definition MoabSkinner.h:593
std::vector< Real > _density_bin_bounds
Bounds of the density bins.
Definition MoabSkinner.h:578
std::string _density_name
Name of the MOOSE variable containing the density.
Definition MoabSkinner.h:511
std::vector< moab::EntityHandle > createNodesFromBox(const BoundingBox &box, const Real &factor) const
const Real BIN_TOLERANCE
Tolerance to use for comparing values to bin bounds.
Definition MoabSkinner.h:599
unsigned int _n_write
Count number of times output files have been written.
Definition MoabSkinner.h:240
void setTagData(moab::Tag tag, moab::EntityHandle ent, void *data)
Helper function to wrap moab::tag_set_data for a generic pointer.
const unsigned int NODES_PER_MOAB_TET
Number of nodes per MOAB tet (which are first order, so TET4)
Definition MoabSkinner.h:596
virtual void sortElemsByResults()
Sort all the elements in the [Mesh] into bins for temperature, density, and subdomain.
BoundaryConditionType
Boundary condition types that can be assigned to DAGMC surfaces.
Definition MoabSkinner.h:167
const Real & _temperature_max
Upper bound of temperature bins.
Definition MoabSkinner.h:188
void groupLocalElems(std::set< dof_id_type > elems, std::vector< moab::Range > &localElems)
void buildGraveyard(unsigned int &vol_id, unsigned int &surf_id)
Build a graveyard volume around the domain.
const Real & _graveyard_scale_inner
Multiplier on bounding box for inner surface of graveyard.
Definition MoabSkinner.h:210
std::string boundaryConditionGroupName(BoundaryConditionType bc_type) const
bool _set_bcs
Whether to assign boundary conditions to surfaces.
Definition MoabSkinner.h:527
virtual void findBlocks()
Store a mapping from [Mesh] subdomain IDs to an index, to be used for binning by block ID.
void createSurfaces(moab::Range &faces, VolData &voldata, unsigned int &surf_id, BoundaryConditionType bc_type=BoundaryConditionType::Transmission)
void createBoundaryConditionGroups()
void createSurf(const unsigned int &id, moab::EntityHandle &surface_set, moab::Range &faces, const std::vector< VolData > &voldata, BoundaryConditionType bc_type=BoundaryConditionType::Transmission)
Helper method to create MOAB surface entity set.
Real _scaling
Length multiplier to get from [Mesh] units into OpenMC's centimeters.
Definition MoabSkinner.h:237
bool _set_implicit_complement_material
Whether to assign a material to the implicit complement region.
Definition MoabSkinner.h:228
Real _density_bin_width
Density bin width.
Definition MoabSkinner.h:536
std::string _implicit_complement_group_name
OpenMC material name or ID which will be assigned to the implicit complement.
Definition MoabSkinner.h:231
virtual unsigned int getSubdomainBin(const Elem *const elem) const
Definition MoabSkinner.h:81
virtual void execute() override
std::map< SubdomainID, std::string > _block_id_to_material_name
Map from mesh SubdomainID to OpenMC material name.
Definition MoabSkinner.h:602
bool resetMOAB()
Clear MOAB entity sets.
void createMOABElems()
BoundaryConditionType boundaryConditionType(const Elem *const elem, const unsigned int side, const libMesh::BoundaryInfo &boundary_info) const
std::unique_ptr< NumericVector< Number > > _serialized_solution
Definition MoabSkinner.h:173
unsigned int getAuxiliaryVariableNumber(const std::string &name, const std::string &param_name) const
bool _use_displaced
Whether the skinned mesh should be generated from a displaced mesh.
Definition MoabSkinner.h:234
void updateSurfData(moab::EntityHandle surface_set, const VolData &data)
Add parent-child metadata relating a surface to its volume.
std::map< SubdomainID, unsigned int > _blocks
Blocks in the [Mesh].
Definition MoabSkinner.h:548
void createSurfacesFromSkin(const moab::Range &region, moab::Range &skin, VolData &voldata, unsigned int &surf_id)
virtual unsigned int nDensityBins() const
Definition MoabSkinner.h:150
virtual bool hasDensitySkinning() const
Definition MoabSkinner.h:156
Encode MOAB information about volumes needed when creating surfaces.
Definition MoabSkinner.h:260
moab::EntityHandle vol
Definition MoabSkinner.h:261
Sense sense
Definition MoabSkinner.h:262