.. _qfactor_configuration:

################
gcmotion.qfactor
################

.. currentmodule:: gcmotion.qfactor

Here is a list of the availiable q-factor configurations:

===================================       ==========================
Unity q-factor                            :py:class:`Unity`
Parabolic q-factor                        :py:class:`Parabolic`
Hypergeometric q-factor                   :py:class:`Hypergeometric`
PrecomputedHypergeometric q-factor        :py:class:`PrecomputedHypergeometric`
(Numerical) SmartPositive                 :py:class:`SmartPositive`
(Numerical) SmartNegative                 :py:class:`SmartNegative`
(Numerical) SmartNegative2                :py:class:`SmartNegative2`
(Numerical) DTTPositive                   :py:class:`DTTPositive`
(Numerical) DTTNegative                   :py:class:`DTTNegative`
===================================       ==========================

Their parameters are documented below.

Examples
--------

>>> import gcmotion as gcm
>>>
>>> # Quantity Constructor
>>> Rnum = 1.6
>>> anum = 0.5
>>> B0num = 1
>>> species = "p"
>>> Q = gcm.QuantityConstructor(R=Rnum, a=anum, B0=B0num, species=species)
>>>
>>> # Intermediate values
>>> a = Q(anum, "meters")
>>> B0 = Q(B0num, "Tesla")
>>>
>>> # Some qfactors
>>> qfactor1 = gcm.qfactor.Unity()
>>> qfactor3 = gcm.qfactor.Parabolic(a, B0, q0=1.1, q_wall=3.8)
>>> qfactor3 = gcm.qfactor.Hypergeometric(a, B0, q0=1.1, q_wall=3.8, n=2)

Creating a numerical Qfactor. Use the respective Initializer to grab the normalization constants from the dataset automatically. See :ref:`Initializers <initializers_docs>`

>>> import gcmotion as gcm
>>> 
>>> # Quantity Constructor
>>> species = "p"
>>> smart_init = gcm.SmartNegativeInit(species)
>>> Q = smart_init.QuantityConstructor()
>>> 
>>> # Intermediate Quantities
>>> R = smart_init.R
>>> a = smart_init.a
>>> B0 = smart_init.B0
>>>
>>> qfactor=gcm.qfactor.SmartNegative(),

.. note::

    The values of `a` and `B0` are necessary whenever we define the qfactor
    with reference to its value at the wall.

*******
Methods
*******

The functions `solverqNU` and `psipNU` work identically in every class,
so I list their methods :ref:`here <base-classes-documentation>`. 

.. autofunction:: gcmotion.qfactor.QFactor.solverqNU

.. autofunction:: gcmotion.qfactor.QFactor.psipNU

.. _available_qfactors:

*******************
Available q-factors
*******************

.. rubric:: Unity

.. autoclass:: Unity
   :class-doc-from: class

.. rubric:: Parabolic

.. autoclass:: Parabolic
   :class-doc-from: class

.. rubric:: Hypergeometric

.. autoclass:: Hypergeometric
   :class-doc-from: class

.. rubric:: PrecomputedHypergeometric

.. autoclass:: PrecomputedHypergeometric
   :class-doc-from: class

.. rubric:: SmartPositive

.. autoclass:: SmartPositive
   :class-doc-from: class

.. rubric:: SmartNegative

.. autoclass:: SmartNegative
   :class-doc-from: class

.. rubric:: SmartNegative2

.. autoclass:: SmartNegative2
   :class-doc-from: class

.. rubric:: DTTPositive

.. autoclass:: DTTPositive
   :class-doc-from: class

.. rubric:: DTTNegative

.. autoclass:: DTTNegative
   :class-doc-from: class