![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
Functions | |
| template<int dim> | |
| const DeprecatedEnumNames< typename Shape< dim >::ShapeType > & | deprecated_shape_type_names () |
| template<int dim> | |
| Shape< dim >::ShapeType | string_to_shape_type (const std::string &type) |
| template<int dim> | |
| std::shared_ptr< Shape< dim > > | initialize_shape (const std::string &type, const std::string &shape_arguments_str, const Point< dim > &position, const Tensor< 1, 3 > &orientation) |
| template<int dim> | |
| std::shared_ptr< Shape< dim > > | initialize_shape_from_vector (const std::string &type, const std::vector< double > &shape_arguments, const Point< dim > &position, const Tensor< 1, 3 > &orientation) |
| template<int dim> | |
| std::shared_ptr< Shape< dim > > | initialize_shape_from_file (const std::string &type, const std::string &file_name, const Point< dim > &position, const Tensor< 1, 3 > &orientation) |
| template const DeprecatedEnumNames< Shape< 3 >::ShapeType > & ShapeGenerator::deprecated_shape_type_names< 3 > | ( | ) |
Return the deprecated strings of the shape types, which remain accepted in parameter files, composite shape files and particle files.
| dim | Number of spatial dimensions. |
Definition at line 12 of file shape_parsing.cc.
| std::shared_ptr< Shape< dim > > ShapeGenerator::initialize_shape | ( | const std::string & | type, |
| const std::string & | shape_arguments_str, | ||
| const Point< dim > & | position, | ||
| const Tensor< 1, 3 > & | orientation ) |
Initializes the shape from its type and arguments
| type | the type of shape |
| shape_arguments_str | the raw arguments |
| position | the position of the shape |
| orientation | the orientation of the shape |
Definition at line 37 of file shape_parsing.cc.
References initialize_shape_from_file(), initialize_shape_from_vector(), and string_to_shape_type().
| std::shared_ptr< Shape< dim > > ShapeGenerator::initialize_shape_from_file | ( | const std::string & | type, |
| const std::string & | file_name, | ||
| const Point< dim > & | position, | ||
| const Tensor< 1, 3 > & | orientation ) |
Initializes the shape from its type and a text file that contains the real initialization data
| type | the type of shape |
| file_name | the name of the file that contains the initialization data |
| position | the position of the shape |
| orientation | the orientation of the shape |
Definition at line 195 of file shape_parsing.cc.
References CompositeShape< dim >::Difference, initialize_shape(), CompositeShape< dim >::Intersection, string_to_shape_type(), and CompositeShape< dim >::Union.
| std::shared_ptr< Shape< dim > > ShapeGenerator::initialize_shape_from_vector | ( | const std::string & | type, |
| const std::vector< double > & | shape_arguments, | ||
| const Point< dim > & | position, | ||
| const Tensor< 1, 3 > & | orientation ) |
Initializes the shape from its type and numerical arguments
| type | the type of shape |
| shape_arguments | the numerical arguments |
| position | the position of the shape |
| orientation | the orientation of the shape |
Definition at line 70 of file shape_parsing.cc.
References string_to_shape_type().
| template Shape< 3 >::ShapeType ShapeGenerator::string_to_shape_type< 3 > | ( | const std::string & | type | ) |
Return the shape type designated by a string, which is either the name of a Shape<dim>::ShapeType enumerator or one of the deprecated strings given by deprecated_shape_type_names(). No deprecation warning is printed, since the string may come from a composite shape file or a particle file rather than from a parameter.
| dim | Number of spatial dimensions. |
| [in] | type | String designating the type of shape. |
type designates no shape type. Definition at line 26 of file shape_parsing.cc.
References deprecated_shape_type_names(), and string_to_enum().