view src/fem_coeff.cc @ 50:fcfecdd3a9b5

Maint: improve the documentation
author gedeone-octave <marco.vassallo@outlook.com>
date Thu, 25 Jul 2013 09:04:36 +0200
parents fca8c3d75036
children d6df5cc8ef53
line wrap: on
line source

/*
 Copyright (C) 2013 Marco Vassallo

 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 2 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 "coefficient.h"

DEFUN_DLD (fem_coeff, args, , "-*- texinfo -*-\n\
@deftypefn {Function File} {[@var{f}]} = \
fem_coeff (@var{name}, @var{Functio handle}\n\
The input parameters are\n\
@itemize @bullet \n\
@item @var{name} is the name of the coefficient declared in the .ufl file\n\
@item @var{Functio handle} is a function handle which contains the expression\
that we want to apply for our coefficient\n\
@end itemize\n\
The output @var{f} is an object which contains a representation of the function\n\
@seealso{fem_init_mesh, fem_fs}\n\
@end deftypefn")
{
  int nargin = args.length ();
  octave_value retval=0;

  if (nargin < 2 || nargin > 2)
    print_usage ();
  else
    {
      std::string str = args(0).string_value ();
      octave_fcn_handle * fh = args(1).fcn_handle_value ();

      if (! coefficient_type_loaded)
        {
          coefficient::register_type ();
          coefficient_type_loaded = true;
          mlock ();
        }

      if (!error_state)
        retval = new coefficient (str, *fh);

   }

  return retval;
}