The FemRepresentationParameters class defines the physical parameters for all Finite Element Model (1D, 2D, 3D)
More...
#include <SurgSim/Physics/FemRepresentationParameters.h>
|
void | checkValidity () |
| Check the validity of the parameters and set the flag m_isValid accordingly. More...
|
|
The FemRepresentationParameters class defines the physical parameters for all Finite Element Model (1D, 2D, 3D)
SurgSim::Physics::FemRepresentationParameters::FemRepresentationParameters |
( |
| ) |
|
SurgSim::Physics::FemRepresentationParameters::~FemRepresentationParameters |
( |
| ) |
|
|
virtual |
bool SurgSim::Physics::FemRepresentationParameters::addBoundaryCondition |
( |
size_t |
nodeId | ) |
|
Add a boundary condition.
- Parameters
-
nodeId | The nodeId of the Fem to be fixed |
- Returns
- True if the boundary condition has been added, False otherwise
size_t SurgSim::Physics::FemRepresentationParameters::addBoundaryConditions |
( |
const std::vector< size_t > & |
boundaryConditions | ) |
|
Add boundary conditions.
- Parameters
-
boundaryConditions | The vector of all boundary conditions to be added (nodeIdx) |
- Returns
- The number of boundary conditions actually added
void SurgSim::Physics::FemRepresentationParameters::checkValidity |
( |
| ) |
|
|
private |
Check the validity of the parameters and set the flag m_isValid accordingly.
void SurgSim::Physics::FemRepresentationParameters::clearBoundaryConditions |
( |
| ) |
|
Remove all boundary conditions.
double SurgSim::Physics::FemRepresentationParameters::getBoundaryConditionInverseMass |
( |
| ) |
const |
Get the boundary condition inverse mass property.
- Returns
- The inverse mass assigned to boundary condition nodes
double SurgSim::Physics::FemRepresentationParameters::getBoundaryConditionMass |
( |
| ) |
const |
Get the boundary condition mass property.
- Returns
- The mass assigned to boundary condition nodes
const std::vector< size_t > & SurgSim::Physics::FemRepresentationParameters::getBoundaryConditions |
( |
| ) |
const |
Get all boundary conditions.
- Returns
- The vector of all boundary conditions (nodeIds)
double SurgSim::Physics::FemRepresentationParameters::getDensity |
( |
| ) |
const |
Get the mass density of the fem.
- Returns
- The density if it has been provided, 0 otherwise (in Kg.m-3)
double SurgSim::Physics::FemRepresentationParameters::getPoissonRatio |
( |
| ) |
const |
Get the material Poisson ratio.
- Returns
- The Poisson ratio of the material (unitless)
double SurgSim::Physics::FemRepresentationParameters::getRayleighDampingMass |
( |
| ) |
const |
Get the Rayleigh damping mass parameter.
- Returns
- The Rayleigh damping mass parameter (in s-1)
double SurgSim::Physics::FemRepresentationParameters::getRayleighDampingStiffness |
( |
| ) |
const |
Get the Rayleigh damping stiffness parameter.
- Returns
- The Rayleigh damping stiffness parameter (in s)
double SurgSim::Physics::FemRepresentationParameters::getYoungModulus |
( |
| ) |
const |
Get the material Young modulus.
- Returns
- The Young modulus of the material (in N.m-2)
bool SurgSim::Physics::FemRepresentationParameters::isValid |
( |
| ) |
const |
Test if the the parameters are fully set and ready.
- Returns
- True if the set of parameters is valid
- Note
- Valid if mass density and Young modulus strictly positive
-
and Poisson ratio in ]-1, 0.5[ and both Rayleigh parameters positive or null
Comparison operator (difference test)
- Parameters
-
- Returns
- False if the 2 parameters set are equals, True otherwise
Comparison operator (equality test)
- Parameters
-
- Returns
- True if the 2 parameters set are equals, False otherwise
bool SurgSim::Physics::FemRepresentationParameters::removeBoundaryCondition |
( |
size_t |
nodeId | ) |
|
Remove a boundary condition.
- Parameters
-
nodeId | The nodeId of the Fem to be removed from the boundary conditions list |
- Returns
- True if the boundary condition has been removed, False otherwise
void SurgSim::Physics::FemRepresentationParameters::setBoundaryConditionInverseMass |
( |
double |
invMass | ) |
|
Set the boundary condition inverse mass property.
- Parameters
-
invMass | The inverse mass to be assigned to boundary condition nodes |
void SurgSim::Physics::FemRepresentationParameters::setBoundaryConditionMass |
( |
double |
mass | ) |
|
Set the boundary condition mass property.
- Parameters
-
mass | The mass to be assigned to boundary condition nodes |
void SurgSim::Physics::FemRepresentationParameters::setDensity |
( |
double |
rho | ) |
|
Set the mass density of the fem.
- Parameters
-
rho | The mass density (in Kg.m-3) |
void SurgSim::Physics::FemRepresentationParameters::setPoissonRatio |
( |
double |
nu | ) |
|
Set the Poisson ratio of the material.
- Parameters
-
nu | The Poisson ratio of the material (unitless) |
void SurgSim::Physics::FemRepresentationParameters::setRayleighDampingMass |
( |
double |
massCoef | ) |
|
Set the Rayleigh damping mass parameter.
- Parameters
-
massCoef | The Rayleigh damping mass parameter (in s-1) |
void SurgSim::Physics::FemRepresentationParameters::setRayleighDampingStiffness |
( |
double |
stiffnessCoef | ) |
|
Set the Rayleigh damping stiffness parameter.
- Parameters
-
stiffnessCoef | The Rayleigh damping stiffness parameter (in s) |
void SurgSim::Physics::FemRepresentationParameters::setYoungModulus |
( |
double |
E | ) |
|
Set the Young modulus of the material.
- Parameters
-
E | The Young modulus of the material (in N.m-2) |
std::vector<size_t> SurgSim::Physics::FemRepresentationParameters::m_boundaryConditions |
|
private |
Boundary conditions (vector of node indices to fix)
double SurgSim::Physics::FemRepresentationParameters::m_boundaryConditionsInverseMass |
|
private |
Boundary conditions mass property (useful to build the system matrix inverse) Note that m_boundaryConditionsInverseMass can be different than 1.0/m_boundaryConditionsMass.
double SurgSim::Physics::FemRepresentationParameters::m_boundaryConditionsMass |
|
private |
Boundary conditions mass property (useful to build the system matrix)
bool SurgSim::Physics::FemRepresentationParameters::m_isValid |
|
private |
Validity of the set of parameters.
double SurgSim::Physics::FemRepresentationParameters::m_poissonRatio |
|
private |
Poisson ratio (unit less) Theoretically within (-1, 0.5) with 0.5 for incompressible material In general within [ 0, 0.5)
double SurgSim::Physics::FemRepresentationParameters::m_rayleighDampingMass |
|
private |
Rayleigh damping, mass parameter (in s-1)
double SurgSim::Physics::FemRepresentationParameters::m_rayleighDampingStiffness |
|
private |
Rayleigh damping, stiffness parameter (in s)
double SurgSim::Physics::FemRepresentationParameters::m_rho |
|
private |
Density of the object (in Kg.m-3)
double SurgSim::Physics::FemRepresentationParameters::m_youngModulus |
|
private |
Young modulus (in N.m-2 or Pa or Kg.m-1.s-2)
The documentation for this class was generated from the following files: