Ignore:
Timestamp:
08/08/12 11:48:34 (13 years ago)
Author:
jschierm
Message:

CHG: Made python docstrings have consistent indentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • issm/trunk-jpl/src/m/model/setflowequation.py

    r12888 r12944  
    99        SETELEMENTSTYPE - associate a solution type to each element
    1010
    11             This routine works like plotmodel: it works with an even number of inputs
    12             'hutter','macayeal','pattyn','stokes' and 'fill' are the possible options
    13             that must be followed by the corresponding exp file or flags list
    14             It can either be a domain file (argus type, .exp extension), or an array of element flags.
    15             If user wants every element outside the domain to be
    16             setflowequationd, add '~' to the name of the domain file (ex: '~Pattyn.exp');
    17             an empty string '' will be considered as an empty domain
    18             a string 'all' will be considered as the entire domain
    19             You can specify the type of coupling, 'penalties' or 'tiling', to use with the input 'coupling'
    20 
    21             Usage:
    22                md=setflowequation(md,varargin)
    23 
    24             Example:
    25                md=setflowequation(md,'pattyn','Pattyn.exp','macayeal',md.mask.elementonfloatingice,'fill','hutter');
    26                md=setflowequation(md,'pattyn','Pattyn.exp',fill','hutter','coupling','tiling');
     11           This routine works like plotmodel: it works with an even number of inputs
     12           'hutter','macayeal','pattyn','stokes' and 'fill' are the possible options
     13           that must be followed by the corresponding exp file or flags list
     14           It can either be a domain file (argus type, .exp extension), or an array of element flags.
     15           If user wants every element outside the domain to be
     16           setflowequationd, add '~' to the name of the domain file (ex: '~Pattyn.exp');
     17           an empty string '' will be considered as an empty domain
     18           a string 'all' will be considered as the entire domain
     19           You can specify the type of coupling, 'penalties' or 'tiling', to use with the input 'coupling'
     20
     21           Usage:
     22              md=setflowequation(md,varargin)
     23
     24           Example:
     25              md=setflowequation(md,'pattyn','Pattyn.exp','macayeal',md.mask.elementonfloatingice,'fill','hutter');
     26              md=setflowequation(md,'pattyn','Pattyn.exp',fill','hutter','coupling','tiling');
    2727        """
    2828
Note: See TracChangeset for help on using the changeset viewer.