.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEConfGen


.. oe:constnamespace:: OEFragBuilderMode

   This namespace contains constants that are used with
   :oe:meth:`OEConfGen::OEFragBuilderOptions` to control the
   defaults to be set for fragment building options. Different sets of default options
   prepare the FragBuilder to generate structures that are suitable for different
   uses.

   .. oe:constant:: Default

      Same as :oe:const:`OEConfGen::OEFragBuilderMode::Fast`.


   .. oe:constant:: Dense

      Options suitable for building fragments with the
      :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` in the :oe:const:`OEConfGen::OEOmegaSampling::Dense`
      mode.

      ====================================================================  ========  ====  ==========
      Option                                                                Non-Ring  Ring  Macrocycle
      --------------------------------------------------------------------  --------  ----  ----------
      :oe:meth:`EnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`    15.0      15.0  25.0

      :oe:meth:`FragGen<OEConfGen::OEFragOptions::SetFragGen>`              40        1024  2000

      :oe:meth:`FragKeep<OEConfGen::OEFragOptions::SetFragKeep>`            1         1024  1024

      :oe:meth:`RMS<OEConfGen::OEFragOptions::SetRMS>`                      0.05      0.05  0.1

      :oe:meth:`TimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`          3600      3600  1800

      :oe:meth:`StartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`  X         100   X
      ====================================================================  ========  ====  ==========

   .. oe:constant:: Fast
   
      Options suitable for fast, on-the-fly building of fragments during molecule building 
      with the :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>`.

      ====================================================================  ========  ====  ==========
      Option                                                                Non-Ring  Ring  Macrocycle
      --------------------------------------------------------------------  --------  ----  ----------
      :oe:meth:`EnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`    8.0       8.0   25.0

      :oe:meth:`FragGen<OEConfGen::OEFragOptions::SetFragGen>`              40        1024  2000

      :oe:meth:`FragKeep<OEConfGen::OEFragOptions::SetFragKeep>`            1         1024  1024

      :oe:meth:`RMS<OEConfGen::OEFragOptions::SetRMS>`                      0.1       0.1   0.1

      :oe:meth:`TimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`          400       400   1800

      :oe:meth:`StartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`  X         2     X
      ====================================================================  ========  ====  ========== 

   .. oe:constant:: Strict
   
      Options suitable for rigorous fragment structure generation, suitable for building a
      fragment library with the :ref:`OEMakeFragLib <OEConfGen_OEMakeFragLib>`.

      ====================================================================  ========  =====  ==========
      Option                                                                Non-Ring  Ring   Macrocycle
      --------------------------------------------------------------------  --------  -----  ----------
      :oe:meth:`EnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`    4.0       4.0    25.0

      :oe:meth:`FragGen<OEConfGen::OEFragOptions::SetFragGen>`              40        50000  2000

      :oe:meth:`FragKeep<OEConfGen::OEFragOptions::SetFragKeep>`            1         1024   1024

      :oe:meth:`RMS<OEConfGen::OEFragOptions::SetRMS>`                      0.1       0.1    0.1

      :oe:meth:`TimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`          400       400    1800

      :oe:meth:`StartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`  X         20     X
      ====================================================================  ========  =====  ========== 
