Mercurial > fem-fenics-eugenio
view src/save_func.cc @ 270:f4d6ae912a08 default tip
Correct typos in the doc-strings
author | Eugenio Gianniti <eugenio.gianniti@mail.polimi.it> |
---|---|
date | Thu, 14 Aug 2014 17:55:32 +0200 |
parents | 61830a4f9ab9 |
children |
line wrap: on
line source
/* Copyright (C) 2013 Marco Vassallo <gedeone-octave@users.sourceforge.net> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, see <http://www.gnu.org/licenses/>. */ #include "function.h" #include "dolfin_compat.h" DEFUN_DLD (save, args, , "-*- texinfo -*-\n\ @deftypefn {Function File} \ save (@var{Function}, @var{Name})\n\ Save a function in vtu format.\n\ The input parameters are\n\ @itemize @bullet \n\ @item @var{Function} is the function that you want to save\n\ @item @var{Name} is a string for the output name\n\ @end itemize\n\ The output is a file in format .vtu\n\ @seealso{plot, Function}\n\ @end deftypefn") { int nargin = args.length (); octave_value retval; if (nargin < 2 || nargin > 2) { print_usage (); } else { if (! function_type_loaded) { function::register_type (); function_type_loaded = true; mlock (); } if (args(0).type_id () == function::static_type_id ()) { const function & uo = static_cast<const function &> (args(0).get_rep ()); std::string str = args(1).string_value (); if (!error_state) { const SHARED_PTR <const dolfin::Function> & u = uo.get_pfun (); str += ".pvd"; dolfin::File file (str); file << (*u); retval = 0; } } } return retval; }