![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <solid_objects_parameters.h>
Public Member Functions | |
| RigidSolidObject ()=default | |
| void | declare_parameters (ParameterHandler &prm, unsigned int id) |
| void | parse_parameters (ParameterHandler &prm, unsigned int id) |
Public Attributes | |
| Parameters::Mesh< dim, spacedim > | solid_mesh |
| bool | output_bool |
| std::shared_ptr< Function< spacedim > > | translational_velocity |
| std::shared_ptr< Function< spacedim > > | angular_velocity |
| Point< spacedim > | center_of_rotation |
| std::shared_ptr< Function< spacedim > > | solid_temperature |
| SolidObjectThermalBoundaryType | thermal_boundary_type |
Parameters for a single rigid solid object used in DEM simulations.
This class stores the mesh, motion, temperature, and output parameters for a rigid solid. The velocity fields are stored as std::shared_ptr<Function<dim>> so that any function type can be used (e.g., ParsedFunction for parameter-file input or ConstantFunction for unit tests).
| dim | Number of spatial dimensions. |
Definition at line 364 of file solid_objects_parameters.h.
|
default |
| void Parameters::RigidSolidObject< dim, spacedim >::declare_parameters | ( | ParameterHandler & | prm, |
| unsigned int | id ) |
Declare the parameters in the parameter handler.
| [in,out] | prm | The parameter handler object. |
| [in] | id | Index of the solid object. |
Definition at line 412 of file solid_objects_parameters.h.
References Parameters::adiabatic, angular_velocity, declare_enum_entry(), solid_mesh, solid_temperature, and translational_velocity.
| void Parameters::RigidSolidObject< dim, spacedim >::parse_parameters | ( | ParameterHandler & | prm, |
| unsigned int | id ) |
Parse the parameters from the parameter handler.
| [in] | prm | The parameter handler object. |
| [in] | id | Index of the solid object. |
Definition at line 469 of file solid_objects_parameters.h.
References angular_velocity, center_of_rotation, convert_string_to_vector(), output_bool, solid_mesh, solid_temperature, string_to_enum(), thermal_boundary_type, and translational_velocity.
| std::shared_ptr<Function<spacedim> > Parameters::RigidSolidObject< dim, spacedim >::angular_velocity |
Angular velocity function of the solid object.
Definition at line 397 of file solid_objects_parameters.h.
| Point<spacedim> Parameters::RigidSolidObject< dim, spacedim >::center_of_rotation |
Center of rotation used to locate and rotate the solid object.
Definition at line 400 of file solid_objects_parameters.h.
| bool Parameters::RigidSolidObject< dim, spacedim >::output_bool |
Controls the generation of output files for this solid.
Definition at line 391 of file solid_objects_parameters.h.
| Parameters::Mesh<dim, spacedim> Parameters::RigidSolidObject< dim, spacedim >::solid_mesh |
Mesh parameters for the solid object.
Definition at line 388 of file solid_objects_parameters.h.
| std::shared_ptr<Function<spacedim> > Parameters::RigidSolidObject< dim, spacedim >::solid_temperature |
Temperature function for the solid object boundary.
Definition at line 403 of file solid_objects_parameters.h.
| SolidObjectThermalBoundaryType Parameters::RigidSolidObject< dim, spacedim >::thermal_boundary_type |
Type of thermal boundary condition applied on the solid surface.
Definition at line 406 of file solid_objects_parameters.h.
| std::shared_ptr<Function<spacedim> > Parameters::RigidSolidObject< dim, spacedim >::translational_velocity |
Translational velocity function of the solid object.
Definition at line 394 of file solid_objects_parameters.h.