Template Struct cmesh_example_with_parameter

Inheritance Relationships

Base Type

Struct Documentation

template<class ...Args>
struct cmesh_example_with_parameter : public cmesh_example_base

Class to hold cmesh example created by function with parameters as input.

Template Parameters:

Args

Public Functions

inline cmesh_example_with_parameter(std::function<t8_cmesh_t(Args...)> function, std::tuple<Args...> parameter, std::function<std::string(const Args&...)> parameter_to_string, std::string name)

Constructor for a cmesh example created by a function with parameters as input.

Parameters:
  • function[in] Function to create a cmesh from parameters.

  • parameter[in] Tuple of parameters to be passed to the function.

  • parameter_to_string[in] Function to convert parameters to a string.

  • name[in] of the example cmesh.

inline virtual t8_cmesh_t cmesh_create() const

Create the cmesh with given function and parameters.

Returns:

The created cmesh.

inline virtual void param_to_string(std::string &out) const

Convert the parameters of this example to a string.

Parameters:

out[out] string with the parameters of this example cmesh.

Public Members

std::function<t8_cmesh_t(Args...)> cmesh_function

Function to create a cmesh from parameters.

std::tuple<Args...> parameter

Tuple of parameters to be passed to the function.

std::function<std::string(const Args&...)> parameter_to_string

Function to convert parameters to a string.