Wildmeshing Toolkit
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
wmtk::components::procedural::Grid3Options Class Reference

#include <Grid3Options.hpp>

Classes

struct  Coordinates
 

Public Types

enum class  TilingType { BCC = 0 , Freudenthal = 1 }
 

Public Member Functions

std::optional< std::string > get_coordinate_name () const
 

Public Attributes

TilingType tiling_type
 
std::array< int64_t, 3 > dimensions
 
std::bitset< 3 > cycles
 
std::optional< Coordinates > coordinates
 

Static Public Attributes

static const std::array< std::string, 2 > tiling_names = {{"bcc", "freudenthal"}}
 

Friends

void to_json (nlohmann::json &nlohmann_json_j, const Grid3Options &nlohmann_json_t)
 
void from_json (const nlohmann::json &nlohmann_json_j, Grid3Options &nlohmann_json_t)
 

Detailed Description

Definition at line 11 of file Grid3Options.hpp.

Member Enumeration Documentation

◆ TilingType

enum wmtk::components::procedural::Grid3Options::TilingType
strong
Enumerator
BCC 
Freudenthal 

Definition at line 14 of file Grid3Options.hpp.

Member Function Documentation

◆ get_coordinate_name()

std::optional<std::string> wmtk::components::procedural::Grid3Options::get_coordinate_name ( ) const
inline

Definition at line 26 of file Grid3Options.hpp.

References coordinates.

Friends And Related Function Documentation

◆ from_json

void from_json ( const nlohmann::json &  nlohmann_json_j,
Grid3Options &  nlohmann_json_t 
)
friend

Definition at line 47 of file Grid3Options.hpp.

◆ to_json

void to_json ( nlohmann::json &  nlohmann_json_j,
const Grid3Options &  nlohmann_json_t 
)
friend

Definition at line 34 of file Grid3Options.hpp.

Member Data Documentation

◆ coordinates

std::optional<Coordinates> wmtk::components::procedural::Grid3Options::coordinates

Definition at line 25 of file Grid3Options.hpp.

Referenced by get_coordinate_name().

◆ cycles

std::bitset<3> wmtk::components::procedural::Grid3Options::cycles

Definition at line 18 of file Grid3Options.hpp.

◆ dimensions

std::array<int64_t, 3> wmtk::components::procedural::Grid3Options::dimensions

Definition at line 17 of file Grid3Options.hpp.

◆ tiling_names

const std::array< std::string, 2 > wmtk::components::procedural::Grid3Options::tiling_names = {{"bcc", "freudenthal"}}
static

Definition at line 15 of file Grid3Options.hpp.

◆ tiling_type

TilingType wmtk::components::procedural::Grid3Options::tiling_type

Definition at line 16 of file Grid3Options.hpp.

Referenced by wmtk::components::procedural::make_mesh().

The documentation for this class was generated from the following files: