GSI_Toolbox 1.0.0
A toolbox for Gas-Surface Interaction simulations
|
A class representing a surface with geometry and statistical properties. More...
#include <Surface.h>
Public Member Functions | |
Surface () | |
Default constructor for Surface class. | |
Surface (std::string geometry_file, std::string properties_file) | |
Parameterized constructor for Surface class. | |
~Surface () | |
Destructor for Surface class. | |
void | import_properties (std::string properties_file) |
Imports surface properties from a file. | |
Matrix< T > | get_mu_coefficients () |
Retrieves the mu coefficients for the surface. | |
Matrix< T > | get_sigma_coefficients () |
Retrieves the sigma coefficients for the surface. | |
Geometry< T > & | get_geometry () |
Retrieves the geometry of the surface. | |
T | autocorrelation_length () |
Retrieves the autocorrelation length of the surface. | |
T * | get_local_parameters () |
Retrieves the local parameters of the surface. | |
A class representing a surface with geometry and statistical properties.
The Surface class stores the geometric data and statistical properties (e.g., autocorrelation length, mu and sigma coefficients) required for surface modeling and interaction in simulations.
T | Type parameter for numerical data (typically float or double). |
Surface< T >::Surface | ( | std::string | geometry_file, |
std::string | properties_file ) |
Parameterized constructor for Surface class.
Parameterized constructor for Surface.
geometry_file | The file containing surface geometry data. |
properties_file | The file containing surface properties (e.g., mu, sigma coefficients). |
Initializes the geometry from a file and imports surface properties from another file.
geometry_file | The file containing surface geometry data. |
properties_file | The file containing surface properties (e.g., mu, sigma coefficients). |
|
inline |
Retrieves the autocorrelation length of the surface.
Retrieves the geometry of the surface.
|
inline |
Retrieves the local parameters of the surface.
Retrieves the mu coefficients for the surface.
Retrieves the sigma coefficients for the surface.
void Surface< T >::import_properties | ( | std::string | properties_file | ) |
Imports surface properties from a file.
Imports the surface properties from a file.
Reads the surface properties, such as mu and sigma coefficients, and autocorrelation length from the provided properties file.
properties_file | The file containing surface properties. |
Reads the mu and sigma coefficients and autocorrelation length from the properties file and stores them in the appropriate member variables.
properties_file | The file containing surface properties. |