.. role:: ts-api-decorator

########################
MassedParticleParameters
########################

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: MassedParticleParameters

      Parameters for Massed Particle Traces.

      If these parameters are specified in the ``ParticleTraceGroup.massedParticleParameters`` property, 
      the particle trace will be computed based on a massed particle formulation using the given 
      parameters.

      To compute normal steam lines (massless particles), set ``ParticleTraceGroup.massedParticleParameters`` 
      to undefined (this is the default setting).



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.ug.MassedParticleParameters.constantFluidDensity`
   * :js:attr:`~cee.ug.MassedParticleParameters.constantFluidViscosity`
   * :js:attr:`~cee.ug.MassedParticleParameters.density`
   * :js:attr:`~cee.ug.MassedParticleParameters.fluidDensityResultId`
   * :js:attr:`~cee.ug.MassedParticleParameters.fluidViscosityResultId`
   * :js:attr:`~cee.ug.MassedParticleParameters.gravity`
   * :js:attr:`~cee.ug.MassedParticleParameters.radius`
   * :js:attr:`~cee.ug.MassedParticleParameters.restitutionCoefficient`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.constantFluidDensity

      :type: number

      The constant fluid density to use if the fluidDensityResultId is not set (-1)



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.constantFluidViscosity

      :type: number

      The constant fluid viscosity to use if the fluidViscosityResultId is not set (-1)



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.density

      :type: number

      Particle density



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.fluidDensityResultId

      :type: number

      ID of scalar result for fluid density



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.fluidViscosityResultId

      :type: number

      ID of scalar result for fluid molecular viscosity



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.gravity

      :type: Vec3Like

      Gravity (e.g. <0,0,-9.81> for normal earth gravity if in SI system)



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.radius

      :type: number

      Particle radius



.. container:: ts-api-section

   .. js:attribute:: MassedParticleParameters.restitutionCoefficient

      :type: number :ts-api-decorator:`optional`

      Coefficient of restitution _(Currently not in use)_



