source: trunk/anuga_documentation/coding_standards/anuga_naming_conventions.tex @ 8899

\documentclass{manual}

\title{ANUGA Naming Conventions}

\author{Ole Nielsen, Stephen Roberts}

\usepackage{graphicx}


% Please at least include a long-lived email address;
% the rest is at your discretion.
\authoraddress{Geoscience Australia \\
  Email: \email{ole.nielsen@ga.gov.au}
}

%Draft date
\date{\today}                   % update before release.
                % Use an explicit date so that reformatting
                % doesn't cause a new date to be used.  Setting
                % the date to \today can be used during draft
                % stages to make it easier to handle versions.

                
\makeindex          % tell \index to actually write the .idx file
%\makemodindex          % If this contains a lot of module sections.



\begin{document}
\maketitle



% This makes the contents more accessible from the front page of the HTML.
\ifhtml
\chapter*{Front Matter\label{front}}
\fi




\chapter{Introduction} 

This document outlines naming conventions for the ANUGA hydrodynamic modelling software.



\section{Variables}
\label{sec:variables}


\begin{tabular}{|p{8cm} p{8cm}|}  \hline
\textbf{Name} & \textbf{Symbol} & \textbf{Description}  \\ \hline \hline
node\_coordinates & (x, y) & coordinates of point in triangular mesh where vertices are connected. \\
triangle & (i, j, k) & indices of nodes constituting one mesh triangle. Nodes must be listed in counter clockwise order. Alternative names are currently 'volumes' and 'elements'. \\
\\

vertex\_values
vertex\_coordinates
node\_values
centroid\_coordinates
centroid\_values

polygon & & \\




\end{document}