Commit db7642d8 authored by Dave Moxey's avatar Dave Moxey

Add user guide documentation, fix Windows compilation error.

parent 393eda70
......@@ -26,13 +26,13 @@ through a basic example to show how a mesh can be converted from the widely-used
mesh-generator \gmsh to the XML file format.
\begin{notebox}
The default since Jan 2016 is to output the .xml files in a
The default since January 2016 is to output the \inltt{.xml} files in a
compressed form where the VERTEX, EDGES, FACES, ELEMENTS and CURVED
information is compressed into binary format which is then
converted into base64. This is identified for each section by the attribute
\inltt{COMPRESSED="B64Z-LittleEndian''}. To output
in ascii format add the module option ``:xml:uncompress'' to the .xml file,
i.e. \\ \inltt{ \mc file.msh newfile.xml:xml:uncompress}
information is compressed into binary format which is then converted into
base64. This is identified for each section by the attribute
\inltt{COMPRESSED="B64Z-LittleEndian''}. To output in ascii format add the
module option ``:xml:uncompress'' to the \inltt{.xml} file, i.e. \\ \inltt{
\mc file.msh newfile.xml:xml:uncompress}
\end{notebox}
\section{Exporting a mesh from \gmsh}
......@@ -274,7 +274,9 @@ The following output formats are supported:
\toprule
\textbf{Format} & \textbf{Extension} & \textbf{High-order} & \textbf{Notes}\\
\midrule
Gmsh & \texttt{msh} & \cmark & Curvature output is highly experimental.\\
Gmsh & \texttt{msh} & \cmark & High-order hexes, quads, tetrahedra and
triangles are supported up to arbitrary order. Prisms supported up to order
4, pyramids up to order 1.\\
Nektar++ & \texttt{xml} & \cmark & Most functionality supported. \\
VTK & \texttt{vtk} & \xmark & Experimental. Only ASCII triangular data is supported. \\
\bottomrule
......@@ -288,13 +290,21 @@ meshes since robustness is not guaranteed.
The default for \texttt{xml} is into binary data which has been
converted into base64. If you wish to see an ascii output you need to
specify the output module option \inltt{uncompress} by executing:
%
\begin{lstlisting}[style=BashInputStyle]
NekMesh Mesh.msh output.xml:xml:uncompress
\end{lstlisting}
In the rest of these subsections, we discuss the various processing modules
available within \mc.
%
Finally, both the Gmsh and Nektar++ output modules support an \inltt{order}
parameter, which allows you to generate a mesh of a uniform polynomial
order. This is used in the same manner as the above, so that the command
%
\begin{lstlisting}[style=BashInputStyle]
NekMesh Mesh.msh output.msh:msh:order=7
\end{lstlisting}
%
will generate an order 7 Gmsh mesh. In the rest of these subsections, we discuss
the various processing modules available within \mc.
\subsection{Extract surfaces from a mesh}
......
......@@ -133,8 +133,8 @@ public:
/// Returns the total number of entities in the mesh.
NEKMESHUTILS_EXPORT unsigned int GetNumEntities();
void MakeOrder(int order,
LibUtilities::PointsType distType);
NEKMESHUTILS_EXPORT void MakeOrder(int order,
LibUtilities::PointsType distType);
};
/// Shared pointer to a mesh.
typedef boost::shared_ptr<Mesh> MeshSharedPtr;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment