Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CPEX 046 v2: Particle extension #3

Merged
merged 17 commits into from
Nov 28, 2024
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
20 changes: 20 additions & 0 deletions CGNS-ReST-site/source/current/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -361,4 +361,24 @@ Obstructed Elbow
:Data File: :download:`tut21.cgns.gz<../../example_cgns_files/AdapcoTut21/tut21.cgns.gz>` (61Kb)


Box with Particles
^^^^^^^^^^^^^^^^^^

.. list-table::
:header-rows: 1

* - Contact
- Posted Date
- Revision Date
* - `Alexandre Minot <[email protected]>`_
- Jul.10.24
- Jul.10.24

.. image:: ../../example_cgns_files/Particles/particle_box.png
:width: 200px

:Description: Spray in a 3D box of Air: Unstructured mesh with particles in two ParticleZones.
:Data File: :download:`particles_example.cgns.gz<../../example_cgns_files/Particles/particles_example.cgns.gz>` (295Kb)


.. last line
48 changes: 46 additions & 2 deletions CGNS-ReST-site/source/standard/FMM/CGNSBase.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,33 @@ CGNSBase Figure
- :sidskey:`CellDimension`, :sidskey:`PhysicalDimension`
* - Child Nodes:
- :ref:`Zone_t figure <ZoneFigure>`


.. container:: figelem2

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- User defined
* - Label:
- :sidsref:`ParticleZone_t`
* - Data-Type:
- :sidskey:`cgsize_t`
* - Dimensions:
- 1
* - Dimension Values:
- 1
* - Data:
- :sidskey:`ParticleSize`
* - Cardinality:
- 0, *N*
* - Parameters:
- :sidskey:`PhysicalDimension`
* - Child Nodes:
- :ref:`ParticleZone_t figure <ParticleZoneFigure>`

.. container:: figelem2

.. list-table::
Expand Down Expand Up @@ -262,7 +288,25 @@ CGNSBase Figure
* - Parameters:
- :sidskey:`CellDimension`
* - Child Nodes:
- :ref:`FlowEquationSet_t figure <FlowEquationSetFigure>`
- :ref:`FlowEquationSet_t figure <FlowEquationSetFigure>`

.. container:: figelem2

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- :sidskey:`ParticleEquationSet`
* - Label:
- :sidsref:`ParticleEquationSet_t`
* - Data-Type:
- :sidskey:`MT`
* - Cardinality:
- 0,1
* - Child Nodes:
- :ref:`ParticleEquationSet_t figure <ParticleEquationSetFigure>`

.. container:: figelem2

Expand Down
105 changes: 105 additions & 0 deletions CGNS-ReST-site/source/standard/FMM/ParticleBreakupModel.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
.. CGNS Documentation files
See LICENSING/COPYRIGHT at root dir of this documentation sources

.. default-domain:: sids

.. role:: sidskey(code)

.. role:: sidsref(code)

.. _ParticleBreakupModelFigure:

ParticleBreakupModel Figure
===========================

.. container:: fighead

**ParticleBreakupModel Node**

(See :ref:`ParticleEquationSet_t figure <ParticleEquationSetFigure>` )



.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- User defined
* - Label:
- :sidsref:`Descriptor_t`
* - See:
- :ref:`CGNSBase_t figure <CGNSBaseFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- :sidskey:`DataClass`
* - Label:
- :sidsref:`DataClass_t`
* - See:
- :ref:`CGNSBase_t figure <CGNSBaseFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- :sidskey:`DimensionalUnits`
* - Label:
- :sidsref:`DimensionalUnits_t`
* - See:
- :ref:`DimensionalUnits_t figure <DimensionalUnitsFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- Data-name identifier or user defined
* - Label:
- :sidsref:`DataArray_t`
* - Data-Type:
- :sidskey:`DataType`
* - Dimensions:
- 1
* - Dimension Values:
- 1
* - Data:
- Data quantity
* - Cardinality:
- 0, *N*
* - Parameters:
- :sidskey:`DataType`
* - Child Nodes:
- :ref:`DataArray_t figure <DataArrayFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- User defined
* - Label:
- :sidsref:`UserDefinedData_t`
* - See:
- :ref:`UserDefinedData_t figure <UserDefinedDataFigure>`

.. last line
105 changes: 105 additions & 0 deletions CGNS-ReST-site/source/standard/FMM/ParticleCollisionModel.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
.. CGNS Documentation files
See LICENSING/COPYRIGHT at root dir of this documentation sources

.. default-domain:: sids

.. role:: sidskey(code)

.. role:: sidsref(code)

.. _ParticleCollisionModelFigure:

ParticleCollisionModel Figure
=============================

.. container:: fighead

**ParticleCollisionModel Node**

(See :ref:`ParticleEquationSet_t figure <ParticleEquationSetFigure>` )



.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- User defined
* - Label:
- :sidsref:`Descriptor_t`
* - See:
- :ref:`CGNSBase_t figure <CGNSBaseFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- :sidskey:`DataClass`
* - Label:
- :sidsref:`DataClass_t`
* - See:
- :ref:`CGNSBase_t figure <CGNSBaseFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- :sidskey:`DimensionalUnits`
* - Label:
- :sidsref:`DimensionalUnits_t`
* - See:
- :ref:`DimensionalUnits_t figure <DimensionalUnitsFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- Data-name identifier or user defined
* - Label:
- :sidsref:`DataArray_t`
* - Data-Type:
- :sidskey:`DataType`
* - Dimensions:
- 1
* - Dimension Values:
- 1
* - Data:
- Data quantity
* - Cardinality:
- 0, *N*
* - Parameters:
- :sidskey:`DataType`
* - Child Nodes:
- :ref:`DataArray_t figure <DataArrayFigure>`

.. container:: figelem

.. list-table::
:class: figtable
:stub-columns: 1
:widths: 38 62

* - Name:
- User defined
* - Label:
- :sidsref:`UserDefinedData_t`
* - See:
- :ref:`UserDefinedData_t figure <UserDefinedDataFigure>`

.. last line
Loading
Loading