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

.. _sec_mesh:

***********************
Mesh block
***********************

.. literalinclude:: ../xml-blocks/mesh.xml
   :language: xml
   :lines: 1-5
   :caption: `Mesh` block in XML input file.

.. py:data:: Mesh Input Type

  :type: string
  :value: File or Inline
  :usage: Required
  :description: Specify the mesh input type. Mesh can be used from an Exodus file (File) or generated at run time with the Inline option.

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

   .. py:data:: Element Type

      :type: string
      :value: Quad4, Tri3, Hex8, Tet4
      :usage: Required
      :description: Element type to use with inline (uniform) mesh.

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

      .. py:data:: X Block

         :type: integer
         :value: :math:`[0;\infty]`
         :usage: Required
         :description: Number of blocks in the x-direction.

      .. py:data:: Y Block

         :type: integer
         :value: :math:`[0;\infty]`
         :usage: Required
         :description: Number of blocks in the y-direction.

      .. py:data:: Z Block

         :type: integer
         :value: :math:`[0;\infty]`
         :usage: Required in 3D
         :description: Number of blocks in the z-direction.

      .. py:data:: X Elements

         :type: integer
         :value: :math:`[0;\infty]`
         :usage: Required
         :description: Number of mesh elements in x-direction.

      .. py:data:: Y Elements

         :type: integer
         :value: :math:`[0;\infty]`
         :usage: Required
         :description: Number of mesh elements in y-direction.

      .. py:data:: Z Elements

         :type: integer
         :value: :math:`[0;\infty]`
         :usage: Required in 3D.
         :description: Number of mesh elements in z-direction.

      .. py:data:: X0

         :type: double
         :value: :math:`[-\infty;\infty]`
         :usage: Required
         :description: x-coordinate of the bottom-left vertex.

      .. py:data:: Y0

         :type: double
         :value: :math:`[-\infty;\infty]`
         :usage: Required
         :description: y-coordinate of the bottom-left vertex.

      .. py:data:: Z0

         :type: double
         :value: :math:`[-\infty;\infty]`
         :usage: Required in 3D.
         :description: z-coordinate of the bottom-left vertex.

      .. py:data:: Xf

         :type: double
         :value: :math:`[-\infty;\infty]`
         :usage: Required
         :description: x-coordinate of the top-right vertex.

      .. py:data:: Yf

         :type: double
         :value: :math:`[-\infty;\infty]`
         :usage: Required
         :description: y-coordinate of the top-right vertex.

      .. py:data:: Zf

         :type: double
         :value: :math:`[-\infty;\infty]`
         :usage: Required in 3D.
         :description: z-coordinate of the top-right vertex.

   .. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_3d_wale_cavity.xml
      :language: xml
      :linenos:
      :lines: 6-20

   .. dropdown:: Periodic BCs
      :icon: multi-select
      :color: secondary
      :animate: fade-in

      .. py:data:: Count

         :type: integer
         :value: N
         :usage: Required
         :description: Number of pair of periodic boundaries in the computational domain.
         :no-index:

      .. py:data:: Periodic Condition N

         :type: string
         :value: N
         :usage: Required
         :description: settings for periodic boundaries. `N` should be replaced with an integer in the name.

   .. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_k_tau_channel.xml
      :language: xml
      :linenos:
      :lines: 8-11

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

   .. py:data:: Decomp Method

      :type: string
      :value: KWAY_GEOM, RCB
      :usage: Required
      :description: method to decompose the mesh when running a HPC simulation.

   .. dropdown:: Periodic BCs
      :icon: multi-select
      :color: secondary
      :animate: fade-in

      .. py:data:: Count

         :type: integer
         :value: N
         :usage: Required
         :description: Number of pair of periodic boundaries in the computational domain.
         :no-index:

      .. py:data:: Periodic Condition N

         :type: string
         :value: N
         :usage: Required
         :description: settings for periodic boundaries. `N` should be replaced with an integer in the name.

   .. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_k_tau_channel.xml
      :language: xml
      :linenos:
      :lines: 5-11