ModelSetup Namespace Reference

Contain the configuration variables that defines an specific simulation. More...

Enumerations
enum	StressUpdateScheme { USF , USL , MUSL }
	Defines the type of scheme used to update the stress. More...
enum	DampingType {   UNDAMPED , LOCAL , KINETIC_DYNAMIC_RELAXATION , UNDAMPED ,   LOCAL , KINETIC_DYNAMIC_RELAXATION }
	Defines the type of damping. More...
enum	DampingType {   UNDAMPED , LOCAL , KINETIC_DYNAMIC_RELAXATION , UNDAMPED ,   LOCAL , KINETIC_DYNAMIC_RELAXATION }
enum	OperationalSystem { WINDOWS , LINUX }
	Defines the current operational system. More...
enum	InterpolationFunctionType { LINEAR , GIMP }
	Defines the type of interpolation function. More...
enum class	HydroMechanicalCouplingType { NONE , ONE_WAY }
	Defines the type of hydro-mechanical coupling. More...

Functions
bool	getWindowsSystem ()
	Return true is the system is Windows.
bool	getLinuxSystem ()
	Return true is the system is Linux.
bool	getLoadState ()
	Return true is load state is activated.
void	setLoadState (bool load_state_activated)
	Set load state activated.
bool	getSaveState ()
	Return true is save state is activated.
void	setSaveState (bool save_state_activated)
	Set save state activated.
unsigned	getContributionNodesNum ()
	Return the number of nodes that a particle contributes.
double	getTimeStep ()
	Return the time step.
void	setTimeStep (double time_step)
	Configure the time step.
double	getTime ()
	Return the simulation time.
void	setTime (double simulation_time)
	Configure the simulation time.
unsigned	getResultNum ()
	Return the total results to be written.
void	setResultNum (unsigned total_results)
	Configure the total results to be written.
unsigned	getResultSteps ()
	Return the every how many steps the results will be written.
double	getCriticalTimeStepMultiplier ()
	Return the critical sime step multiplier.
void	setCriticalTimeStepMultiplier (double critical_time_step_multiplier)
	Configures the fraction of critical time step.
unsigned	getThreads ()
	Return the number of threads in the simulation.
void	setThreads (unsigned n_threads)
	Configures the number of threads.
bool	getContactActive ()
	Return if contact method is activated.
void	setContactActive (bool is_contact_activated)
	Configure if contact method is activated.
bool	getGravityActive ()
	Return if gravity is active.
void	setGravityActive (bool is_gravity_activated)
	Configure if gravity is active.
const Vector3d &	getGravity ()
	Return the gravity vector.
void	setGravity (const Vector3d &gravity)
	Configure the gravity vector.
bool	getAxisymetricActive ()
	Return if axisymetric analisys is active.
void	setAxisymetricActive (bool if_axysimentric_active)
	Configure if axisymetric analisys is active.
bool	getJanumannActive ()
	Return if Jaumann rate is active.
void	setJanumannActive (bool if_jaumann_active)
	Configure if Jaumann rate is active.
string	getInputFile ()
	Return the input file name.
void	setInputFile (string file_name)
	Configure the input file name.
ModelSetup::StressUpdateScheme	getUpdateStressScheme ()
	Return the scheme for updating the stress.
void	setUpdateStressScheme (ModelSetup::StressUpdateScheme stress_sheme_update)
	Configure the scheme for updating the stress.
ModelSetup::DampingType	getDamping ()
	Return the damping type.
double	getDampingLocal ()
	Return the local damping value.
void	setDampingLocalValue (double alpha)
	Configure the local damping value.
void	setDampingType (ModelSetup::DampingType dampingType)
	Configure the damping type.
ModelSetup::DampingType	getDampingType ()
	Return the damping type.
ModelSetup::InterpolationFunctionType	getInterpolationFunction ()
	Return the interpolation functions type.
void	setInterpolationFunction (ModelSetup::InterpolationFunctionType interpolation_functions_type)
	Configure the interpolation functions type.
void	setNumThreads (unsigned nThreads)
	Configure the number of threads in the model.
bool	getSeismicAnalysisActive ()
	Return true if seismic analysis is active.
void	setSeismicAnalysisActive (bool seismic_analysis_active)
	Configure if seismic analysis is active.
bool	getTwoPhaseActive ()
	Return if two-phase calculation is active.
void	setTwoPhaseActive (bool two_phase_calculation_active)
	Configure if two-phase calculation is active.
void	setInitialSimulationTime (std::chrono::system_clock::time_point initialTime)
	Set initial simulation time.
std::chrono::system_clock::time_point	getInitialSimulationTime ()
	Get initial simulation time.
std::string	getSeismicFileName ()
	Return the seismic file name.
double	getCurrentTime ()
	Get current simulation time.
void	setCurrentTime (double currentTime)
	Set current simulation time.
bool	getTerrainContactActive ()
	Return if terrain contact is active.
void	setTerrainContactActive (bool)
	Set terrain contact active.
HydroMechanicalCouplingType	getHydroMechanicalCouplingType ()
	return the hydro-mechanical coupling type
void	setHydroMechanicalCouplingType (HydroMechanicalCouplingType type)
	Set hydro-mechanical coupling type.
bool	getHydroMechOneWayEnabled ()
	Return if one way hydro-mechanical coupling is enabled.
int	getLoopCounter ()
	Get the current loop counter.
void	setLoopCounter (int a)
	Set the current loop counter.
int	incrementLoopCounter ()
	Increment the loop counter by one.

Detailed Description

Contain the configuration variables that defines an specific simulation.

Enumeration Type Documentation

DampingType [1/2]

enum ModelSetup::DampingType

Defines the type of damping.

Defines the type of damping used in the simulation.

This enumeration specifies the damping scheme applied during the analysis. The damping configuration is defined in the input file.

• UNDAMPED:
  No damping is applied. No need to specify any parameter in the input.
• LOCAL:
  Local damping is activated when "local" is specified in the input.
  The damping coefficient is defined through the parameter "value".
  Example:

  "damping": { "type": "local", "value": 0.02 }

• KINETIC_DYNAMIC_RELAXATION:
  Kinetic dynamic relaxation is activated when "kinetic" is specified in the input.
  No additional parameter is required.
  Example:

  "damping": { "type": "kinetic" }

Enumerator
UNDAMPED	No damping applied.
LOCAL	Local damping (requires "value")
KINETIC_DYNAMIC_RELAXATION	Kinetic dynamic relaxation damping.
UNDAMPED	No damping applied.
LOCAL	Local damping (requires "value")
KINETIC_DYNAMIC_RELAXATION	Kinetic dynamic relaxation damping.

DampingType [2/2]

enum ModelSetup::DampingType

Enumerator
UNDAMPED	No damping applied.
LOCAL	Local damping (requires "value")
KINETIC_DYNAMIC_RELAXATION	Kinetic dynamic relaxation damping.
UNDAMPED	No damping applied.
LOCAL	Local damping (requires "value")
KINETIC_DYNAMIC_RELAXATION	Kinetic dynamic relaxation damping.

HydroMechanicalCouplingType

enum class ModelSetup::HydroMechanicalCouplingType

strong

Defines the type of hydro-mechanical coupling.

Enumerator
NONE
ONE_WAY

InterpolationFunctionType

enum ModelSetup::InterpolationFunctionType

Defines the type of interpolation function.

Enumerator
LINEAR
GIMP

OperationalSystem

enum ModelSetup::OperationalSystem

Defines the current operational system.

Enumerator
WINDOWS
LINUX

StressUpdateScheme

enum ModelSetup::StressUpdateScheme

Defines the type of scheme used to update the stress.

Enumerator
USF
USL
MUSL

Function Documentation

getAxisymetricActive()

bool ModelSetup::getAxisymetricActive

(

)

Return if axisymetric analisys is active.

Returns

True is axisymetric condition is active

getContactActive()

bool ModelSetup::getContactActive

(

)

Return if contact method is activated.

Returns

True if contact method is activated

getContributionNodesNum()

unsigned ModelSetup::getContributionNodesNum

(

)

Return the number of nodes that a particle contributes.

Returns

The number of nodes that a particle contributes

getCriticalTimeStepMultiplier()

double ModelSetup::getCriticalTimeStepMultiplier

(

)

Return the critical sime step multiplier.

Returns

Time step multiplier

getCurrentTime()

double ModelSetup::getCurrentTime

(

)

Get current simulation time.

Returns

currentTime

getDamping()

ModelSetup::DampingType ModelSetup::getDamping

(

)

Return the damping type.

Returns

Damping type ModelSetup::DampingType

getDampingLocal()

double ModelSetup::getDampingLocal

(

)

Return the local damping value.

Returns

Alpha The value for the local damping

getDampingType()

ModelSetup::DampingType ModelSetup::getDampingType

(

)

Return the damping type.

Returns

dampingType Damping type ModelSetup::DampingType

getGravity()

const Vector3d & ModelSetup::getGravity

(

)

Return the gravity vector.

Returns

A vector containing the gravity acceleration in each direction

getGravityActive()

bool ModelSetup::getGravityActive

(

)

Return if gravity is active.

Returns

True if gravity active

getHydroMechanicalCouplingType()

HydroMechanicalCouplingType ModelSetup::getHydroMechanicalCouplingType

(

)

return the hydro-mechanical coupling type

Returns

HydroMechanicalCouplingType

getHydroMechOneWayEnabled()

bool ModelSetup::getHydroMechOneWayEnabled

(

)

Return if one way hydro-mechanical coupling is enabled.

Returns

True if one-way hydro-mechanical coupling is enabled

getInitialSimulationTime()

std::chrono::system_clock::time_point ModelSetup::getInitialSimulationTime

(

)

Get initial simulation time.

Returns

initialTime

getInputFile()

string ModelSetup::getInputFile

(

)

Return the input file name.

Returns

File name

getInterpolationFunction()

ModelSetup::InterpolationFunctionType ModelSetup::getInterpolationFunction

(

)

Return the interpolation functions type.

Returns

interpolation_functions_type Interpolation functions type ModelSetup::InterpolationFunctionType

getJanumannActive()

bool ModelSetup::getJanumannActive

(

)

Return if Jaumann rate is active.

Returns

True if Jaumann rate correction is active

getLinuxSystem()

bool ModelSetup::getLinuxSystem

(

)

Return true is the system is Linux.

Returns

True if is Linux system

getLoadState()

bool ModelSetup::getLoadState

(

)

Return true is load state is activated.

Returns

True is load state is activated

getLoopCounter()

int ModelSetup::getLoopCounter

(

)

Get the current loop counter.

Returns

loopCounter

getResultNum()

unsigned ModelSetup::getResultNum

(

)

Return the total results to be written.

Returns

Number of results

getResultSteps()

unsigned ModelSetup::getResultSteps

(

)

Return the every how many steps the results will be written.

Returns

Number of steps

getSaveState()

bool ModelSetup::getSaveState

(

)

Return true is save state is activated.

Returns

True is save state is activated

getSeismicAnalysisActive()

bool ModelSetup::getSeismicAnalysisActive

(

)

Return true if seismic analysis is active.

Returns

if_seismic_analysis_active

getSeismicFileName()

std::string ModelSetup::getSeismicFileName

(

)

Return the seismic file name.

getTerrainContactActive()

bool ModelSetup::getTerrainContactActive

(

)

Return if terrain contact is active.

getThreads()

unsigned ModelSetup::getThreads

(

)

Return the number of threads in the simulation.

Returns

Number of threads

getTime()

double ModelSetup::getTime

(

)

Return the simulation time.

Returns

Simulation time

getTimeStep()

double ModelSetup::getTimeStep

(

)

Return the time step.

Returns

Time step

getTwoPhaseActive()

bool ModelSetup::getTwoPhaseActive

(

)

Return if two-phase calculation is active.

Returns

True if two-phase calculation is active

getUpdateStressScheme()

ModelSetup::StressUpdateScheme ModelSetup::getUpdateStressScheme

(

)

Return the scheme for updating the stress.

Returns

Stress scheme update ModelSetup::StressUpdateScheme

getWindowsSystem()

bool ModelSetup::getWindowsSystem

(

)

Return true is the system is Windows.

Returns

True if is Windows system

incrementLoopCounter()

int ModelSetup::incrementLoopCounter

(

)

Increment the loop counter by one.

Returns

The current loop counter value

setAxisymetricActive()

void ModelSetup::setAxisymetricActive

(

bool

if_axysimentric_active

)

Configure if axisymetric analisys is active.

Parameters

[in]

if_axysimentric_active

Axisymetric active value

setContactActive()

void ModelSetup::setContactActive

(

bool

is_contact_activated

)

Configure if contact method is activated.

Parameters

[in]

is_contact_activated

Contact active

setCriticalTimeStepMultiplier()

void ModelSetup::setCriticalTimeStepMultiplier

(

double

critical_time_step_multiplier

)

Configures the fraction of critical time step.

Parameters

[in]

critical_time_step_multiplier

Critical time step multiplier

setCurrentTime()

void ModelSetup::setCurrentTime

(

double

currentTime

)

Set current simulation time.

Parameters

[in]

currentTime

setDampingLocalValue()

void ModelSetup::setDampingLocalValue

(

double

alpha

)

Configure the local damping value.

Parameters

[in]

alpha

Local damping value

setDampingType()

void ModelSetup::setDampingType

(

ModelSetup::DampingType

dampingType

)

Configure the damping type.

Parameters

[in]

dampingType

Damping type ModelSetup::DampingType

setGravity()

void ModelSetup::setGravity

(

const Vector3d &

gravity

)

Configure the gravity vector.

Parameters

[in]

gravity

A vector containing the gravity acceleration in each direction

setGravityActive()

void ModelSetup::setGravityActive

(

bool

is_gravity_activated

)

Configure if gravity is active.

Parameters

[in]

is_gravity_activated

Gravity active

setHydroMechanicalCouplingType()

void ModelSetup::setHydroMechanicalCouplingType

(

HydroMechanicalCouplingType

type

)

Set hydro-mechanical coupling type.

Parameters

[in]

type

HydroMechanicalCouplingType

setInitialSimulationTime()

void ModelSetup::setInitialSimulationTime

(

std::chrono::system_clock::time_point

initialTime

)

Set initial simulation time.

Parameters

[in]

initialTime

setInputFile()

void ModelSetup::setInputFile

(

string

file_name

)

Configure the input file name.

Parameters

[in]

file_name

File name

setInterpolationFunction()

void ModelSetup::setInterpolationFunction

(

ModelSetup::InterpolationFunctionType

interpolation_functions_type

)

Configure the interpolation functions type.

Parameters

[in]

interpolation_functions_type

Interpolation functions type ModelSetup::InterpolationFunctionType

setJanumannActive()

void ModelSetup::setJanumannActive

(

bool

if_jaumann_active

)

Configure if Jaumann rate is active.

Parameters

[in]

if_jaumann_active

Jaumann active value

setLoadState()

void ModelSetup::setLoadState

(

bool

load_state_activated

)

Set load state activated.

Parameters

[in]

load_state_activated

Flag to load an state

setLoopCounter()

void ModelSetup::setLoopCounter

(

int

a

)

Set the current loop counter.

Parameters

[in]

a

The loop counter value

setNumThreads()

void ModelSetup::setNumThreads

(

unsigned

nThreads

)

Configure the number of threads in the model.

Parameters

[in]

nThreads

Number of threads

setResultNum()

void ModelSetup::setResultNum

(

unsigned

total_results

)

Configure the total results to be written.

Parameters

[in]

total_results

Number of results

setSaveState()

void ModelSetup::setSaveState

(

bool

save_state_activated

)

Set save state activated.

Parameters

[in]

save_state_activated

Flag to save an state

setSeismicAnalysisActive()

void ModelSetup::setSeismicAnalysisActive

(

bool

seismic_analysis_active

)

Configure if seismic analysis is active.

Parameters

[in]

seismic_analysis_active

setTerrainContactActive()

void ModelSetup::setTerrainContactActive

(

bool

)

Set terrain contact active.

setThreads()

void ModelSetup::setThreads

(

unsigned

n_threads

)

Configures the number of threads.

Parameters

[in]

n_threads

Number of threads

setTime()

void ModelSetup::setTime

(

double

simulation_time

)

Configure the simulation time.

Parameters

[in]

simulation_time

Simulation time

setTimeStep()

void ModelSetup::setTimeStep

(

double

time_step

)

Configure the time step.

Parameters

[in]

time_step

Time step

setTwoPhaseActive()

void ModelSetup::setTwoPhaseActive

(

bool

two_phase_calculation_active

)

Configure if two-phase calculation is active.

Parameters

[in]

two_phase_calculation_active

setUpdateStressScheme()

void ModelSetup::setUpdateStressScheme

(

ModelSetup::StressUpdateScheme

stress_sheme_update

)

Configure the scheme for updating the stress.

Parameters

[in]

stress_sheme_update

Stress scheme update ModelSetup::StressUpdateScheme