ContactParameters Class Reference

The ContactParameters class stores parameters for the 'Contact'' XML element used to specify parameter values for contact computations.
More...

#include <Parameters.h>

Inheritance diagram for ContactParameters:

Public Member Functions
void	print_parameters ()
void	set_values (tinyxml2::XMLElement *xml_elem)
Public Member Functions inherited from ParameterLists
void	set_xml_element_name (const std::string &name)
void	set_parameter (const std::string &name, const bool value, bool required, Parameter< bool > &param)
	Set the name, default value and the parameter required flag. More...
void	set_parameter (const std::string &name, const double value, bool required, Parameter< double > &param)
void	set_parameter (const std::string &name, std::initializer_list< double > value, bool required, VectorParameter< double > &param)
void	set_parameter (const std::string &name, std::initializer_list< int > value, bool required, VectorParameter< int > &param)
void	set_parameter (const std::string &name, std::initializer_list< std::string > value, bool required, VectorParameter< std::string > &param)
void	set_parameter (const std::string &name, const int value, bool required, Parameter< int > &param, std::vector< int > range={})
void	set_parameter (const std::string &name, const std::string &value, bool required, Parameter< std::string > &param)
void	set_parameter_value (const std::string &name, const std::string &value)
	Set the value of a paramter from a string. More...
void	check_required ()
	Check if any required parameters have not been set. More...
std::map< std::string, std::string >	get_parameter_list ()
	Get the defined parameters as a map of strings. More...
void	print_parameter_list ()
	Print the parameters. More...

Public Attributes
Parameter< double >	closest_gap_to_activate_penalty
Parameter< double >	desired_separation
Parameter< double >	min_norm_of_face_normals
Parameter< std::string >	model
Parameter< double >	penalty_constant
Public Attributes inherited from ParameterLists
std::map< std::string, std::variant< Parameter< bool > *, Parameter< double > *, Parameter< int > *, Parameter< std::string > *, VectorParameter< double > *, VectorParameter< int > *, VectorParameter< std::string > * > >	params_map
	Map used for storing parameters by name / Parameter template union. More...
std::string	xml_element_name = ""

Static Public Attributes
static const std::string	xml_element_name_ = "Contact"
	Process parameters for the 'Contact' XML element used to specify parameters for contact computation. More...

Detailed Description

The ContactParameters class stores parameters for the 'Contact'' XML element used to specify parameter values for contact computations.

Member Data Documentation

xml_element_name_

const std::string ContactParameters::xml_element_name_ = "Contact"

static

Process parameters for the 'Contact' XML element used to specify parameters for contact computation.

Define the XML element name for contact parameters.

---

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

• svFSI/Parameters.h
• svFSI/Parameters.cpp