.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: cee.ug.MassedParticleParameters

   Parameters for Massed Particle Traces.
   
   If these parameters are specified in the :js:func:`ParticleTraceGroup.massedParticleParameters <cee.ug.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 :js:func:`ParticleTraceGroup.massedParticleParameters <cee.ug.ParticleTraceGroup.massedParticleParameters>` to undefined (this is the default setting).
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.ug.MassedParticleParameters.constantFluidDensity`
   * :js:data:`~cee.ug.MassedParticleParameters.constantFluidViscosity`
   * :js:data:`~cee.ug.MassedParticleParameters.density`
   * :js:data:`~cee.ug.MassedParticleParameters.fluidDensityResultId`
   * :js:data:`~cee.ug.MassedParticleParameters.fluidViscosityResultId`
   * :js:data:`~cee.ug.MassedParticleParameters.gravity`
   * :js:data:`~cee.ug.MassedParticleParameters.radius`
   * :js:data:`~cee.ug.MassedParticleParameters.restitutionCoefficient`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.ug.MassedParticleParameters.constantFluidDensity

      .. rst-class:: sig-pretty-signature
      
         | constantFluidDensity: *number*
      
      The constant fluid density to use if the fluidDensityResultId is not set (-1)
      



.. js:data:: cee.ug.MassedParticleParameters.constantFluidViscosity

      .. rst-class:: sig-pretty-signature
      
         | constantFluidViscosity: *number*
      
      The constant fluid viscosity to use if the fluidViscosityResultId is not set (-1)
      



.. js:data:: cee.ug.MassedParticleParameters.density

      .. rst-class:: sig-pretty-signature
      
         | density: *number*
      
      Particle density
      



.. js:data:: cee.ug.MassedParticleParameters.fluidDensityResultId

      .. rst-class:: sig-pretty-signature
      
         | fluidDensityResultId: *number*
      
      ID of scalar result for fluid density
      



.. js:data:: cee.ug.MassedParticleParameters.fluidViscosityResultId

      .. rst-class:: sig-pretty-signature
      
         | fluidViscosityResultId: *number*
      
      ID of scalar result for fluid molecular viscosity
      



.. js:data:: cee.ug.MassedParticleParameters.gravity

      .. rst-class:: sig-pretty-signature
      
         | gravity: :js:class:`Vec3Like <cee.Vec3Like>`
      
      Gravity (e.g. <0,0,-9.81> for normal earth gravity if in SI system)
      



.. js:data:: cee.ug.MassedParticleParameters.radius

      .. rst-class:: sig-pretty-signature
      
         | radius: *number*
      
      Particle radius
      



.. js:data:: cee.ug.MassedParticleParameters.restitutionCoefficient

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | restitutionCoefficient: *number*
      
      Coefficient of restitution *(Currently not in use)*
      




