.. ############################################################################
.. manual/packages/vertex-cfd/user_data.rst
.. ############################################################################

.. _sec_user_data:

***********************
User data block
***********************
      
.. literalinclude:: ../xml-blocks/user_data.xml
   :language: xml
   :lines: 1-5
   :caption: `User Data` block in XML input file.

.. py:data:: Output Graph

  :type: bool
  :value: True or False
  :usage: Required
  :description: Output the Panzer graph. Useful when debugging.
      
.. py:data:: Workset Size

  :type: integer
  :value: :math:`[0;\infty]`
  :usage: Required
  :description: Set the workset size as defined by Trilinos.

.. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_concentric_cylinder_convection.xml
   :language: xml
   :linenos:
   :lines: 35-36
      
.. py:data:: CFL

  :type: double
  :value: :math:`[0;\infty]`
  :usage: Optional
  :default: None
  :description: CFL condition for transient solver.
      
.. py:data:: CFL_init

  :type: double
  :value: :math:`[0;\infty]`
  :usage: Optional
  :default: CFL value
  :description: Initial value of CFL condition to use when ramping CFL.
      
.. py:data:: CFL_transition

  :type: double
  :value: :math:`[0;\infty]`
  :usage: Optional
  :default: 0
  :description: Number of time steps to ramp the CFL condition over..

.. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_concentric_cylinder_convection.xml
   :language: xml
   :linenos:
   :lines: 37-39
      
.. py:data:: Build Viscous Flux

  :type: bool
  :value: True or False
  :usage: Optional
  :default: False
  :description: Add viscous flux to momentum equation.

.. py:data:: Build Temperature Equation

  :type: bool
  :value: True or False
  :usage: Optional
  :default: False
  :description: Build the temperature equation.

.. py:data:: Build Buoyancy Source

  :type: bool
  :value: True or False
  :usage: Optional
  :default: False
  :description: Add Buoyancy force to momentum equation
      
.. py:data:: Gravity

  :type: array(double)
  :value: Vector of real value
  :usage: Optional
  :default: None
  :description: Gravity vector.

.. py:data:: Continuity Model

  :type: string
  :value: AC, EDAC, NCTempEDAC
  :usage: Optional
  :default: AC
  :description: Continuity model to chose between artificial compressibility (AC), entropically damped AC (EDAC), and non-conservative temperature with EDAC.
      
.. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_concentric_cylinder_convection.xml
   :language: xml
   :linenos:
   :lines: 40-44

.. py:data:: Build Viscous Heat

  :type: bool
  :value: True or False
  :usage: Optional
  :default: False
  :description: Add viscous heating to temperature equation
      
.. py:data:: Momentum Source

  :type: array(double)
  :value: Vector of real value
  :usage: Optional
  :requirement: Require `Build Constant Source` set to `True`.
  :description: Constant source terms for momentum equations.

.. py:data:: Energy Source

  :type: double
  :value: Real
  :usage: Optional
  :requirement: Require `Build Constant Source` and `Build Temperature Equation` set to `True`.
  :description: Constant source term for temperature equation.
      
.. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_planar_poiseuille.xml
   :language: xml
   :linenos:
   :lines: 67

.. dropdown:: Compute Error Norms
   :icon: multi-select
   :color: primary
   :animate: fade-in-slide-down
      
   .. py:data:: Output Frequency

      :type: int
      :value: Real
      :usage: Optional
      :default: :math:`\infty`
      :description: Set frequency to output error norms during transient.
      
   .. py:data:: Compute Time Integral

      :type: bool
      :value: True or False
      :usage: Optional
      :default: True
      :description: When enabled, error norms are accumulated over transient.
      
   .. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_planar_poiseuille.xml
      :language: xml
      :linenos:
      :lines: 61-64

.. dropdown:: Turbulence Parameters
   :icon: multi-select
   :color: primary
   :animate: fade-in-slide-down

   .. dropdown:: Numerical Model
      :icon: multi-select
      :color: secondary
      :animate: fade-in

      .. py:data:: Tau model

         :type: string
         :value: Steady, Transient, NoSUPG
         :usage: Required
         :description: Model for stabilization parameter used in SUPG numerical method.

      .. py:data:: Tau coefficient

         :type: double
         :value: :math:`[0;1]`
         :default: 0.5
         :conflict: None
         :usage: Optional
         :description: Coefficient that multiplies the stabilization parameter :math:`\tau` defined with *Tau model*.

   .. literalinclude:: ../../../../examples/inputs/incompressible/external_interpolation.xml
      :language: xml
      :linenos:
      :lines: 249-249
      :emphasize-lines: 1