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

Class for defining how the loads are going to be combined for an specific analysis. More...

#include <LoadCombo.hpp>

Collaboration diagram for LoadCombo:

Public Member Functions

 LoadCombo (std::string name, std::vector< unsigned int > loads, std::vector< double > factors)
 Creates a LoadCombo object. More...
 
 ~LoadCombo ()
 Destroys this LoadCombo object. More...
 
std::string GetCombinationName () const
 Returns the loads to combine. More...
 
std::vector< double > GetLoadFactors () const
 Returns the loads factors. More...
 
std::vector< unsigned int > GetLoadCombination () const
 Returns the Load identifiers to be combined,. More...
 

Private Attributes

std::string Name
 The combination's name. More...
 
std::vector< unsigned int > Loads
 The loads to be combined. More...
 
std::vector< double > Factors
 The factors of combination. More...
 

Detailed Description

Class for defining how the loads are going to be combined for an specific analysis.

See also
Load.hpp StaticAnalysis.hpp DynamicAnalysis.hpp

Constructor & Destructor Documentation

◆ LoadCombo()

LoadCombo::LoadCombo ( std::string  name,
std::vector< unsigned int >  loads,
std::vector< double >  factors 
)

Creates a LoadCombo object.

Parameters
nameName of the load combination object.
loadsThe load identifiers to be combined.
factorsNumerical combinational values.
Note
More details can be found at LoadCombo
See also
Load.

◆ ~LoadCombo()

LoadCombo::~LoadCombo ( )

Destroys this LoadCombo object.

Member Function Documentation

◆ GetCombinationName()

std::string LoadCombo::GetCombinationName ( ) const

Returns the loads to combine.

Returns
The name of the combination.
See also
LoadCombo::Name.

◆ GetLoadCombination()

std::vector<unsigned int> LoadCombo::GetLoadCombination ( ) const

Returns the Load identifiers to be combined,.

Returns
List with the Load identifiers.
Note
More details can be found at LoadCombo
See also
LoadCombo::Loads.

◆ GetLoadFactors()

std::vector<double> LoadCombo::GetLoadFactors ( ) const

Returns the loads factors.

Returns
List with the combinational factors.
Note
More details can be found at LoadCombo
See also
LoadCombo::Factors.

Member Data Documentation

◆ Factors

std::vector<double> LoadCombo::Factors
private

The factors of combination.

◆ Loads

std::vector<unsigned int> LoadCombo::Loads
private

The loads to be combined.

◆ Name

std::string LoadCombo::Name
private

The combination's name.