netdem::PeriDigmSettings Class Reference

A class representing the settings used in a peridynamic simulation. More...

#include <peridigm_settings.hpp>

Public Member Functions
void	WriteInputFile (std::ostream &os)
	Writes the simulation settings to a file stream in Peridigm-compatible format.

Public Attributes
std::string	result_dir {"tmp/out/peridigm/"}
	The directory where the simulation results should be written.
std::string	peridigm_exe {"Peridigm"}
	The name of the executable used for running the Peridigm code.
double	horizon_factor {3.01}
	The factor by which the horizon should be computed based on the node size.
bool	omit_bonds_between_blocks {false}
	Whether or not bonds between blocks should be omitted.
bool	use_auto_timestep {true}
	Whether or not to use an automatically computed timestep.
double	timestep {1.0e-6}
	The fixed timestep to use if use_auto_timestep is false.
double	timestep_factor {0.95}
	The safety factor used to compute the timestep if use_auto_timestep is true.
double	mech_time {0.0}
	The mechanical time of the simulation.
double	loading_radius_factor {1.5}
	The loading radius factor used for point contact.
double	constrain_radius_factor {1.5}
	The constrain radius factor used for point contact.
int	output_freqency {10}
	The frequency at which output should be written to file.

Detailed Description

A class representing the settings used in a peridynamic simulation.

The PeriDigmSettings class represents the settings used in a peridynamic simulation. It includes methods for writing the settings to file in a format compatible with the Peridigm code.

Member Function Documentation

WriteInputFile()

void netdem::PeriDigmSettings::WriteInputFile ( std::ostream & os )

inline

Writes the simulation settings to a file stream in Peridigm-compatible format.

This method writes the simulation settings to a file stream in Peridigm-compatible format, including the solver settings, compute class parameters, and output settings.

Parameters

os	The output stream to write to.

Member Data Documentation

constrain_radius_factor

double netdem::PeriDigmSettings::constrain_radius_factor {1.5}

The constrain radius factor used for point contact.

The contact force is constrained onto the nodes around the contact point within a radius computed as the product of the node size and the constrain radius factor.

horizon_factor

double netdem::PeriDigmSettings::horizon_factor {3.01}

The factor by which the horizon should be computed based on the node size.

The horizon is computed as the product of the node size and the horizon factor.

loading_radius_factor

double netdem::PeriDigmSettings::loading_radius_factor {1.5}

The loading radius factor used for point contact.

The contact force is scattered onto the nodes around the contact point within a radius computed as the product of the node size and the loading radius factor.

mech_time

double netdem::PeriDigmSettings::mech_time {0.0}

The mechanical time of the simulation.

omit_bonds_between_blocks

bool netdem::PeriDigmSettings::omit_bonds_between_blocks {false}

Whether or not bonds between blocks should be omitted.

output_freqency

int netdem::PeriDigmSettings::output_freqency {10}

The frequency at which output should be written to file.

peridigm_exe

std::string netdem::PeriDigmSettings::peridigm_exe {"Peridigm"}

The name of the executable used for running the Peridigm code.

result_dir

std::string netdem::PeriDigmSettings::result_dir {"tmp/out/peridigm/"}

The directory where the simulation results should be written.

timestep

double netdem::PeriDigmSettings::timestep {1.0e-6}

The fixed timestep to use if use_auto_timestep is false.

timestep_factor

double netdem::PeriDigmSettings::timestep_factor {0.95}

The safety factor used to compute the timestep if use_auto_timestep is true.

use_auto_timestep

bool netdem::PeriDigmSettings::use_auto_timestep {true}

Whether or not to use an automatically computed timestep.

---

The documentation for this class was generated from the following file:

• /Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/peridigm/peridigm_settings.hpp