.. include:: sub.txt

======================
 parameter command
======================

.. function:: parameter(tag, <specific parameter args>)

   In DDM-based FE response sensitivity analysis, the sensitivity parameters can be material,
   geometry or discrete loading parameters. 

   ==============================   ===========================================================================
   ``tag`` |int|                    integer tag identifying the parameter.
   ``<specific parameter args>``    depend on the object in the FE model encapsulating the desired parameters.
   ==============================   ===========================================================================


.. note::

   Each parameter must be unique in the FE domain, and all parameter tags must be numbered sequentially starting from 1.


Examples
---------

#. To identify the elastic modulus, E, of the material 1 at section 3 of element 4, the <specific object arguments> string becomes::
   
     parameter(1, 'element', 4, 'section', 3, 'material', 1, 'E')
   
#. To identify the elastic modulus, E, of elastic section 3 of element 4 (for elastic section, no specific material need to be defined), the <specific object arguments> string becomes::
   
     parameter(1, 'element', 4, 'section', 3, 'E')
   
#. To parameterize E for element 4 with material 1 (no section need to be defined), the <specific object arguments> string simplifies as::

     parameter(1, 'element', 4, 'material', 1, 'E')


.. note::

   Notice that the format of the <specific object arguments> is different for each considered element/section/material. The specific set of parameters and the relative <specific object arguments> format will be added in the future.