view inst/LinearForm.m @ 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 a61fc34334ca
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/>.


## -*- texinfo -*-
## @deftypefn {Function File} {[@var{L}]} = @
## LinearForm (@var{my_problem}, @var{U}, @var{coefficient_1}, @
## @var{coefficient_2},...)
##
## Construct a Functional previously imported from a ufl file.
##
## The compulsory arguments are:
## @itemize @bullet
## @item @var{my_problem} the name of the problem to solve.
## @item the FunctionSpace @var{U} where the problem is defined.
## @end itemize
##
## The optional arguments are the @var{coefficient_1}, @var{coefficient_2} 
## which specify the parameters for the LinearForm with the same name which
## was used in the ufl file.
## They can be either a Constant, a Function or an Expression.
## You can also optionally provide a MeshFunction marking subdomains.
##
## @seealso{import_ufl_LinearForm, import_ufl_Problem, BilinearForm, 
## ResidualForm, MeshFunction}
## @end deftypefn

function a = LinearForm (name, V, varargin)

  if nargin < 2
    error ("LinearForm: wrong number of input parameters.");
  elseif ! ischar (name)
    error ("LinearForm: first argument is not a valid string");
  endif

  program = sprintf ("%s_LinearForm(V", name);
   for k = 1:length (varargin)
      eval(['f_' num2str(k) '=varargin{k};']);
      program = strjoin ({ program, strcat('f_',num2str(k))}, ',');
   end

  program = strjoin ({program, ');'});
  a = eval (program);

endfunction