Seismo-VLAB  1.3
An Open-Source Finite Element Software for Meso-Scale Simulations
Damping Class Reference

Class for applying a certain damping model to a group of elements. More...

#include <Damping.hpp>

Collaboration diagram for Damping:

Public Member Functions

 Damping (std::string name, const std::vector< double > parameters)
 Creates a Damping object. More...
 
 ~Damping ()
 Destroys this Damping object. More...
 
std::string GetName ()
 Gets name of the damping model. More...
 
std::vector< double > GetParameters ()
 Gets parameters of the damping model. More...
 
void SetName (std::string name)
 Set the name of the damping model. More...
 
void SetParameters (std::vector< double > param)
 Set the damping parameters. More...
 

Private Attributes

std::string Name
 Damping model name. More...
 
std::vector< double > Parameters
 Damping model parameters. More...
 

Detailed Description

Class for applying a certain damping model to a group of elements.

See also
Element.hpp Mesh.hpp

Constructor & Destructor Documentation

◆ Damping()

Damping::Damping ( std::string  name,
const std::vector< double >  parameters 
)

Creates a Damping object.

Parameters
nameName of the damping model.
parametersParameters that define the damping model.
Note
More details can be found at Damping.
See also
Damping::Name, Damping::Parameters.

◆ ~Damping()

Damping::~Damping ( )

Destroys this Damping object.

Member Function Documentation

◆ GetName()

std::string Damping::GetName ( )

Gets name of the damping model.

Returns
The name of damping model.
Note
More details can be found at Damping.

◆ GetParameters()

std::vector<double> Damping::GetParameters ( )

Gets parameters of the damping model.

Returns
The list of parameters of damping model.
Note
More details can be found at Damping.

◆ SetName()

void Damping::SetName ( std::string  name)

Set the name of the damping model.

Parameters
nameThe name of damping model.
Note
More details can be found at Damping.

◆ SetParameters()

void Damping::SetParameters ( std::vector< double >  param)

Set the damping parameters.

Parameters
paramThe vector of parameters.
Note
More details can be found at Damping.

Member Data Documentation

◆ Name

std::string Damping::Name
private

Damping model name.

◆ Parameters

std::vector<double> Damping::Parameters
private

Damping model parameters.