\doxysection{Surface\texorpdfstring{$<$}{<} T \texorpdfstring{$>$}{>} Class Template Reference}
\hypertarget{class_surface}{}\label{class_surface}\index{Surface$<$ T $>$@{Surface$<$ T $>$}}


A class representing a surface with geometry and statistical properties.  




{\ttfamily \#include $<$Surface.\+h$>$}

\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_surface_ace2a5889d4f2a1cbd33200a3ccf34e9b}{Surface}} ()
\begin{DoxyCompactList}\small\item\em Default constructor for \doxylink{class_surface}{Surface} class. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_surface_aea6c1e595d64e06fb671bf2e98063dc7}{Surface}} (std\+::string geometry\+\_\+file, std\+::string properties\+\_\+file)
\begin{DoxyCompactList}\small\item\em Parameterized constructor for \doxylink{class_surface}{Surface} class. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_surface_af5bd888f07816c035ee648ffeb7cbe3c}{\texorpdfstring{$\sim$}{\string~}\+Surface}} ()
\begin{DoxyCompactList}\small\item\em Destructor for \doxylink{class_surface}{Surface} class. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_surface_a4b99916b5a9b6e28da928cf0c82e684b}{import\+\_\+properties}} (std\+::string properties\+\_\+file)
\begin{DoxyCompactList}\small\item\em Imports surface properties from a file. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_matrix}{Matrix}}$<$ T $>$ \mbox{\hyperlink{class_surface_ae49ebe885cb762b0f09e23edf6e902cc}{get\+\_\+mu\+\_\+coefficients}} ()
\begin{DoxyCompactList}\small\item\em Retrieves the mu coefficients for the surface. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_matrix}{Matrix}}$<$ T $>$ \mbox{\hyperlink{class_surface_ad498873671c54f8adad50cf95cc75c40}{get\+\_\+sigma\+\_\+coefficients}} ()
\begin{DoxyCompactList}\small\item\em Retrieves the sigma coefficients for the surface. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_geometry}{Geometry}}$<$ T $>$ \& \mbox{\hyperlink{class_surface_aff444bd60c6740c96b2218f876e98d21}{get\+\_\+geometry}} ()
\begin{DoxyCompactList}\small\item\em Retrieves the geometry of the surface. \end{DoxyCompactList}\item 
T \mbox{\hyperlink{class_surface_a40018fe168bd1f761c47160a26e7bbef}{autocorrelation\+\_\+length}} ()
\begin{DoxyCompactList}\small\item\em Retrieves the autocorrelation length of the surface. \end{DoxyCompactList}\item 
T \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{class_surface_a51ee134273b8e968bb34061d482be3c1}{get\+\_\+local\+\_\+parameters}} ()
\begin{DoxyCompactList}\small\item\em Retrieves the local parameters of the surface. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\subsubsection*{template$<$typename T$>$\newline
class Surface$<$ T $>$}
A class representing a surface with geometry and statistical properties. 

The \doxylink{class_surface}{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.


\begin{DoxyTemplParams}{Template Parameters}
{\em T} & Type parameter for numerical data (typically float or double). \\
\hline
\end{DoxyTemplParams}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{class_surface_ace2a5889d4f2a1cbd33200a3ccf34e9b}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!Surface@{Surface}}
\index{Surface@{Surface}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{Surface()}{Surface()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \label{class_surface_ace2a5889d4f2a1cbd33200a3ccf34e9b} 
template$<$typename T $>$ \\
\mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\mbox{\hyperlink{class_surface}{\+::\+Surface}} (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Default constructor for \doxylink{class_surface}{Surface} class. 

Default constructor for \doxylink{class_surface}{Surface}.

Initializes the autocorrelation length to 0. \Hypertarget{class_surface_aea6c1e595d64e06fb671bf2e98063dc7}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!Surface@{Surface}}
\index{Surface@{Surface}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{Surface()}{Surface()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily \label{class_surface_aea6c1e595d64e06fb671bf2e98063dc7} 
template$<$typename T $>$ \\
\mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\mbox{\hyperlink{class_surface}{\+::\+Surface}} (\begin{DoxyParamCaption}\item[{std\+::string}]{geometry\+\_\+file}{, }\item[{std\+::string}]{properties\+\_\+file}{}\end{DoxyParamCaption})}



Parameterized constructor for \doxylink{class_surface}{Surface} class. 

Parameterized constructor for \doxylink{class_surface}{Surface}.


\begin{DoxyParams}{Parameters}
{\em geometry\+\_\+file} & The file containing surface geometry data. \\
\hline
{\em properties\+\_\+file} & The file containing surface properties (e.\+g., mu, sigma coefficients).\\
\hline
\end{DoxyParams}
Initializes the geometry from a file and imports surface properties from another file.


\begin{DoxyParams}{Parameters}
{\em geometry\+\_\+file} & The file containing surface geometry data. \\
\hline
{\em properties\+\_\+file} & The file containing surface properties (e.\+g., mu, sigma coefficients). \\
\hline
\end{DoxyParams}
\Hypertarget{class_surface_af5bd888f07816c035ee648ffeb7cbe3c}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!````~Surface@{\texorpdfstring{$\sim$}{\string~}Surface}}
\index{````~Surface@{\texorpdfstring{$\sim$}{\string~}Surface}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}Surface()}{\string~Surface()}}
{\footnotesize\ttfamily \label{class_surface_af5bd888f07816c035ee648ffeb7cbe3c} 
template$<$typename T $>$ \\
\mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::\texorpdfstring{$\sim$}{\string~}\mbox{\hyperlink{class_surface}{Surface}} (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}



Destructor for \doxylink{class_surface}{Surface} class. 

Destructor for \doxylink{class_surface}{Surface}.

Resets the autocorrelation length to 0.

Sets the autocorrelation length to 0 upon destruction. 

\doxysubsection{Member Function Documentation}
\Hypertarget{class_surface_a40018fe168bd1f761c47160a26e7bbef}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!autocorrelation\_length@{autocorrelation\_length}}
\index{autocorrelation\_length@{autocorrelation\_length}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{autocorrelation\_length()}{autocorrelation\_length()}}
{\footnotesize\ttfamily \label{class_surface_a40018fe168bd1f761c47160a26e7bbef} 
template$<$typename T $>$ \\
T \mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::autocorrelation\+\_\+length (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves the autocorrelation length of the surface. 

\begin{DoxyReturn}{Returns}
The autocorrelation length of the surface. 
\end{DoxyReturn}
\Hypertarget{class_surface_aff444bd60c6740c96b2218f876e98d21}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!get\_geometry@{get\_geometry}}
\index{get\_geometry@{get\_geometry}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{get\_geometry()}{get\_geometry()}}
{\footnotesize\ttfamily \label{class_surface_aff444bd60c6740c96b2218f876e98d21} 
template$<$typename T $>$ \\
\mbox{\hyperlink{class_geometry}{Geometry}}$<$ T $>$ \& \mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::get\+\_\+geometry (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves the geometry of the surface. 

\begin{DoxyReturn}{Returns}
A reference to the geometry object of the surface. 
\end{DoxyReturn}
\Hypertarget{class_surface_a51ee134273b8e968bb34061d482be3c1}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!get\_local\_parameters@{get\_local\_parameters}}
\index{get\_local\_parameters@{get\_local\_parameters}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{get\_local\_parameters()}{get\_local\_parameters()}}
{\footnotesize\ttfamily \label{class_surface_a51ee134273b8e968bb34061d482be3c1} 
template$<$typename T $>$ \\
T \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::get\+\_\+local\+\_\+parameters (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves the local parameters of the surface. 

\begin{DoxyReturn}{Returns}
A pointer to the local parameters array. 
\end{DoxyReturn}
\Hypertarget{class_surface_ae49ebe885cb762b0f09e23edf6e902cc}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!get\_mu\_coefficients@{get\_mu\_coefficients}}
\index{get\_mu\_coefficients@{get\_mu\_coefficients}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{get\_mu\_coefficients()}{get\_mu\_coefficients()}}
{\footnotesize\ttfamily \label{class_surface_ae49ebe885cb762b0f09e23edf6e902cc} 
template$<$typename T $>$ \\
\mbox{\hyperlink{class_matrix}{Matrix}}$<$ T $>$ \mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::get\+\_\+mu\+\_\+coefficients (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves the mu coefficients for the surface. 

\begin{DoxyReturn}{Returns}
The mu coefficients as a \doxylink{class_matrix}{Matrix} object. 
\end{DoxyReturn}
\Hypertarget{class_surface_ad498873671c54f8adad50cf95cc75c40}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!get\_sigma\_coefficients@{get\_sigma\_coefficients}}
\index{get\_sigma\_coefficients@{get\_sigma\_coefficients}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{get\_sigma\_coefficients()}{get\_sigma\_coefficients()}}
{\footnotesize\ttfamily \label{class_surface_ad498873671c54f8adad50cf95cc75c40} 
template$<$typename T $>$ \\
\mbox{\hyperlink{class_matrix}{Matrix}}$<$ T $>$ \mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::get\+\_\+sigma\+\_\+coefficients (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves the sigma coefficients for the surface. 

\begin{DoxyReturn}{Returns}
The sigma coefficients as a \doxylink{class_matrix}{Matrix} object. 
\end{DoxyReturn}
\Hypertarget{class_surface_a4b99916b5a9b6e28da928cf0c82e684b}\index{Surface$<$ T $>$@{Surface$<$ T $>$}!import\_properties@{import\_properties}}
\index{import\_properties@{import\_properties}!Surface$<$ T $>$@{Surface$<$ T $>$}}
\doxysubsubsection{\texorpdfstring{import\_properties()}{import\_properties()}}
{\footnotesize\ttfamily \label{class_surface_a4b99916b5a9b6e28da928cf0c82e684b} 
template$<$typename T $>$ \\
void \mbox{\hyperlink{class_surface}{Surface}}$<$ T $>$\+::import\+\_\+properties (\begin{DoxyParamCaption}\item[{std\+::string}]{properties\+\_\+file}{}\end{DoxyParamCaption})}



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.


\begin{DoxyParams}{Parameters}
{\em properties\+\_\+file} & The file containing surface properties.\\
\hline
\end{DoxyParams}
Reads the mu and sigma coefficients and autocorrelation length from the properties file and stores them in the appropriate member variables.


\begin{DoxyParams}{Parameters}
{\em properties\+\_\+file} & The file containing surface properties. \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
src/Surface.\+h\end{DoxyCompactItemize}
