Changeset 20324

Timestamp:

03/18/16 15:18:08 (9 years ago)

Author:

Mathieu Morlighem

Message:

CHG: homogenized doc

File:

• issm/trunk-jpl/src/m/contrib/defleurian/paraview/exportVTK.m (modified) (1 diff)

issm/trunk-jpl/src/m/contrib/defleurian/paraview/exportVTK.m

@@ -1 +1 @@
 function exportVTK(filename,model,varargin)
-% vtk export
-% function exportVTK(filename,model)
-% creates a directory with the vtk files for displays in paraview
-% (only work for triangle and wedges based on their number of nodes)
+%EXPORTVTK -  vtk export
 %
-%Give only the results for nw but could be extended to geometry, mask... 
+%   function exportVTK(filename,model)
+%   creates a directory with the vtk files for displays in paraview
+%   (only work for triangle and wedges based on their number of nodes)
+%   By default only the results are exported, you can add whichever
+%   field you need as a string:
+%   add 'geometry' to export md.geometry
 %
-% input: filename   destination 
-%                   (string)
-%------------------------------------------------------------------
-%        model      this is md 
-%------------------------------------------------------------------
-% By default only the results are exported, you can add whichever
-% field you need as a string:
-% add 'geometry' to export md.geometry
+%   USAGE:
+%      exportVTK(filename,model,varargin)
 %
-% Basile de Fleurian:
+%   EXAMPLE:
+%      exportVTK('ResultSimulation1',md)
 
 [path,name,ext]=fileparts(filename);