Mundy: Multibody Nonlocal Dynamics Version of the Day
Loading...
Searching...
No Matches
mundy::mesh::MeshBuilder Class Reference

A helper class for building an STK BulkData entity. More...

#include <MeshBuilder.hpp>

Public Member Functions

Constructors and destructor
 MeshBuilder ()
 Default constructor.
 MeshBuilder (stk::ParallelMachine comm)
 Constructor with given given communicator.
Setters
MeshBuilderset_spatial_dimension (const unsigned spatial_dimension)
 Set the spatial dimension of the mash.
MeshBuilderset_entity_rank_names (const std::vector< std::string > &entity_rank_names)
 Set the names assigned to each rank.
MeshBuilderset_communicator (const stk::ParallelMachine &comm)
 Set the MPI communicator to be used by STK.
MeshBuilderset_auto_aura_option (const stk::mesh::BulkData::AutomaticAuraOption &auto_aura_option)
 Set the chosen Aura option. For example, stk::mesh::BulkData::AUTO_AURA.
MeshBuilderset_add_fmwk_data_flag (bool add_fmwk_data_flag)
 Set the add framework data flag.
MeshBuilderset_field_data_manager (stk::mesh::FieldDataManager *const field_data_manager_ptr)
 Set the field data manager.
MeshBuilderset_bucket_capacity (const unsigned bucket_capacity)
 Set the upper bound on the number of mesh entities that may be associated with a single bucket.
MeshBuilderset_initial_bucket_capacity (const unsigned initial_bucket_capacity)
 Set the initial upper bound on the number of mesh entities that may be associated with a single bucket.
MeshBuilderset_maximum_bucket_capacity (const unsigned maximum_bucket_capacity)
 Set the maximum upper bound on the number of mesh entities that may be associated with a single bucket.
MeshBuilderset_upward_connectivity_flag (const bool enable_upward_connectivity)
 Set the flag specifying if upward connectivity will be enabled or not.
Actions
std::shared_ptr< stk::mesh::impl::AuraGhosting > create_aura_ghosting ()
 Create a new aura ghosting instance.
std::shared_ptr< MetaDatacreate_meta_data ()
 Create a new MetaData instance.
std::unique_ptr< BulkDatacreate_bulk_data ()
 Create a new BulkData instance.
std::unique_ptr< BulkDatacreate_bulk_data (std::shared_ptr< MetaData > meta_data)
 Create a new BulkData instance using an existing MetaData instance.

Detailed Description

This class is a duplicate of STK's MeshBuilder with our extended BulkData and MetaMesh in place of STK's.

Constructor & Destructor Documentation

◆ MeshBuilder() [1/2]

mundy::mesh::MeshBuilder::MeshBuilder ( )

◆ MeshBuilder() [2/2]

mundy::mesh::MeshBuilder::MeshBuilder ( stk::ParallelMachine comm)
explicit

Member Function Documentation

◆ set_spatial_dimension()

MeshBuilder & mundy::mesh::MeshBuilder::set_spatial_dimension ( const unsigned spatial_dimension)
Parameters
spatial_dimension[in] The dimension of the space within which the parts and entities reside.

◆ set_entity_rank_names()

MeshBuilder & mundy::mesh::MeshBuilder::set_entity_rank_names ( const std::vector< std::string > & entity_rank_names)
Parameters
entity_rank_names[in] The names assigned to each rank.

◆ set_communicator()

MeshBuilder & mundy::mesh::MeshBuilder::set_communicator ( const stk::ParallelMachine & comm)
Parameters
comm[in] The MPI communicator.

◆ set_auto_aura_option()

MeshBuilder & mundy::mesh::MeshBuilder::set_auto_aura_option ( const stk::mesh::BulkData::AutomaticAuraOption & auto_aura_option)
Parameters
auto_aura_option[in] The chosen Aura option.

◆ set_add_fmwk_data_flag()

MeshBuilder & mundy::mesh::MeshBuilder::set_add_fmwk_data_flag ( bool add_fmwk_data_flag)
Parameters
add_fmwk_data_flag[in] A Siera-specific flag, whose purpose is unbeknownst to me.

◆ set_field_data_manager()

MeshBuilder & mundy::mesh::MeshBuilder::set_field_data_manager ( stk::mesh::FieldDataManager *const field_data_manager_ptr)
Parameters
field_data_manager_ptr[in] Pointer to an existing field data manager.

◆ set_bucket_capacity()

MeshBuilder & mundy::mesh::MeshBuilder::set_bucket_capacity ( const unsigned bucket_capacity)

Although subject to change, the maximum bucket capacity is currently 1024 and the default capacity is 512.

Parameters
bucket_capacity[in] The bucket capacity.

◆ set_initial_bucket_capacity()

MeshBuilder & mundy::mesh::MeshBuilder::set_initial_bucket_capacity ( const unsigned initial_bucket_capacity)

Although subject to change, the maximum bucket capacity is currently 1024 and the default capacity is 512.

Parameters
initial_bucket_capacity[in] The initial bucket capacity.

◆ set_maximum_bucket_capacity()

MeshBuilder & mundy::mesh::MeshBuilder::set_maximum_bucket_capacity ( const unsigned maximum_bucket_capacity)

Although subject to change, the maximum bucket capacity is currently 1024 and the default capacity is 512.

Parameters
bucket_capacity[in] The maximum bucket capacity.

◆ set_upward_connectivity_flag()

MeshBuilder & mundy::mesh::MeshBuilder::set_upward_connectivity_flag ( const bool enable_upward_connectivity)
Parameters
enable_upward_connectivity[in] A flag specifying if upward connectivity will be enabled or not.

◆ create_aura_ghosting()

std::shared_ptr< stk::mesh::impl::AuraGhosting > mundy::mesh::MeshBuilder::create_aura_ghosting ( )

◆ create_meta_data()

std::shared_ptr< MetaData > mundy::mesh::MeshBuilder::create_meta_data ( )

◆ create_bulk_data() [1/2]

std::unique_ptr< BulkData > mundy::mesh::MeshBuilder::create_bulk_data ( )

◆ create_bulk_data() [2/2]

std::unique_ptr< BulkData > mundy::mesh::MeshBuilder::create_bulk_data ( std::shared_ptr< MetaData > meta_data)