penpair

PURPOSE ^

PENPAIR- constructor for penpair object

SYNOPSIS ^

function penpair = penpair(varargin)

DESCRIPTION ^

PENPAIR- constructor for penpair object

   a penpair object is a penalty applied between several grids

   Usage:
      penpair = penpair(varargin)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function penpair = penpair(varargin)
0002 %PENPAIR- constructor for penpair object
0003 %
0004 %   a penpair object is a penalty applied between several grids
0005 %
0006 %   Usage:
0007 %      penpair = penpair(varargin)
0008 
0009 switch nargin
0010 case 0
0011     % if no input arguments, create a default object
0012     penpair.id=NaN;
0013     penpair.dof=NaN;
0014     penpair.grids=zeros(2,1);
0015     penpair.penalty_offset=NaN;
0016     
0017     penpair=class(penpair,'penpair');
0018 case 1
0019     %If single argument of class penpair, we have a copy constructor.
0020     if (isa(varargin{1},'penpair'))
0021         penpair = varargin{1};
0022     else
0023         error('penpair constructor error message: copy constructor called on a non ''penpair'' class object');
0024     end 
0025 otherwise
0026     error('penpair constructor error message: 0 of 1 argument only in input.');
0027 end

Generated on Sun 29-Mar-2009 20:22:55 by m2html © 2003