opengate.physics
================

.. py:module:: opengate.physics


Attributes
----------

.. autoapisummary::

   opengate.physics.cut_particle_names


Classes
-------

.. autoapisummary::

   opengate.physics.UserLimitsPhysics
   opengate.physics.Region


Functions
---------

.. autoapisummary::

   opengate.physics.translate_particle_name_gate2G4


Module Contents
---------------

.. py:data:: cut_particle_names

.. py:function:: translate_particle_name_gate2G4(name)

   Convenience function to translate from names
   used in Gate to those in G4, if necessary.
   Concerns e.g. 'electron' -> 'e-'


.. py:class:: UserLimitsPhysics

   Bases: :py:obj:`opengate_core.G4VPhysicsConstructor`


   Class to be registered to physics list.

   It is essentially a refined version of StepLimiterPhysics which considers the user's
   particles choice of particles to which the step limiter should be added.



   .. py:attribute:: physics_engine
      :value: None



   .. py:attribute:: g4_step_limiter_storage


   .. py:attribute:: g4_special_user_cuts_storage


   .. py:method:: close()


   .. py:method:: ConstructParticle()

      Needs to be defined because C++ base class declares this as purely virtual member.



   .. py:method:: ConstructProcess()

      Overrides method from G4VPhysicsConstructor
      that is called when the physics list is constructed.




.. py:class:: Region(*args, **kwargs)

   Bases: :py:obj:`opengate.base.GateObject`


   FIXME: Documentation of the Region class.


   .. py:attribute:: user_info_defaults


   .. py:attribute:: physics_engine
      :value: None



   .. py:attribute:: root_logical_volumes


   .. py:attribute:: g4_region
      :value: None



   .. py:attribute:: g4_user_limits
      :value: None



   .. py:attribute:: g4_production_cuts
      :value: None



   .. py:attribute:: _g4_region_initialized
      :value: False



   .. py:attribute:: _g4_user_limits_initialized
      :value: False



   .. py:attribute:: _g4_production_cuts_initialized
      :value: False



   .. py:method:: reset()


   .. py:method:: close()


   .. py:method:: release_g4_references()


   .. py:method:: to_dictionary()


   .. py:method:: from_dictionary(d)


   .. py:method:: need_step_limiter()


   .. py:method:: need_user_special_cut()


   .. py:method:: associate_volume(volume)


   .. py:method:: dump_production_cuts()


   .. py:method:: initialize()

      This method wraps around all initialization methods of this class.

      It should be called from the physics_engine,
      after setting the self.physics_engine attribute.



   .. py:method:: initialize_volume_dictionaries()


   .. py:method:: initialize_g4_region()


   .. py:method:: initialize_g4_production_cuts()


   .. py:method:: initialize_g4_user_limits()


   .. py:method:: initialize_em_switches()