<gh_stars>0
# pylint: disable=W0614,W0401,W0611,W0622
# flake8: noqa

"""
Lists all isotherm models which are available.

If adding a custom model, it should be also added below.
"""

from pygaps.utilities.exceptions import ParameterError

from .base_model import IsothermBaseModel
from .bet import BET
from .da import DA
from .dr import DR
from .dslangmuir import DSLangmuir
from .fhvst import FHVST
from .freundlich import Freundlich
from .gab import GAB
from .henry import Henry
from .jensenseaton import JensenSeaton
from .langmuir import Langmuir
from .quadratic import Quadratic
from .temkinapprox import TemkinApprox
from .toth import Toth
from .tslangmuir import TSLangmuir
from .virial import Virial
from .wvst import WVST

# This list has all the available models
_MODELS = [
    Henry,
    Langmuir,
    DSLangmuir,
    TSLangmuir,
    BET,
    GAB,
    Freundlich,
    DA,
    DR,
    Quadratic,
    TemkinApprox,
    Virial,
    Toth,
    JensenSeaton,
    FHVST,
    WVST
]

# This list has all the models which will be used when attempting to
# guess an isotherm model. They are the ones where the fitting
# is fast enough to be acceptable
_GUESS_MODELS = [
    Henry,
    Langmuir,
    DSLangmuir,
    DR,
    Freundlich,
    Quadratic,
    BET,
    TemkinApprox,
    Toth,
    JensenSeaton
]

# This list has all the models which work with IAST.
# This is required as some models (such as Freundlich)
# are not physically consistent.
_IAST_MODELS = [
    Henry,
    Langmuir,
    DSLangmuir,
    TSLangmuir,
    Quadratic,
    BET,
    TemkinApprox,
    Toth,
    JensenSeaton
]


def get_isotherm_model(model_name):
    """
    Check whether specified model name exists and return an instance of that model class.

    Parameters
    ----------
    model_name : str
        The name of the requested model

    Returns
    -------
    ModelIsotherm
        A specific model

    Raises
    ------
    ParameterError
        When the model does not exist
    """
    for _model in _MODELS:
        if model_name == _model.name:
            return _model()

    raise ParameterError("Model {0} not an option. Viable models "
                         "are {1}.".format(model_name, [model.name for model in _MODELS]))


def is_iast_model(model_name):
    """
    Check whether specified model can be used with IAST.

    Parameters
    ----------
    model_name : str
        The name of the model

    Returns
    -------
    bool
        Whether it is applicable or not.

    """
    return model_name in [model.name for model in _IAST_MODELS]


def is_base_model(model):
    """
    Check whether the input is derived from the base model.

    Parameters
    ----------
    model : Model
        A derived IsothermBaseModel class

    Returns
    -------
    bool
        True or false.

    """
    return isinstance(model, IsothermBaseModel)

# pylint: disable=W0614,W0401,W0611,W0622
# flake8: noqa

"""
Lists all isotherm models which are available.

If adding a custom model, it should be also added below.
"""

from pygaps.utilities.exceptions import ParameterError

from .base_model import IsothermBaseModel
from .bet import BET
from .da import DA
from .dr import DR
from .dslangmuir import DSLangmuir
from .fhvst import FHVST
from .freundlich import Freundlich
from .gab import GAB
from .henry import Henry
from .jensenseaton import JensenSeaton
from .langmuir import Langmuir
from .quadratic import Quadratic
from .temkinapprox import TemkinApprox
from .toth import Toth
from .tslangmuir import TSLangmuir
from .virial import Virial
from .wvst import WVST

# This list has all the available models
_MODELS = [
    Henry,
    Langmuir,
    DSLangmuir,
    TSLangmuir,
    BET,
    GAB,
    Freundlich,
    DA,
    DR,
    Quadratic,
    TemkinApprox,
    Virial,
    Toth,
    JensenSeaton,
    FHVST,
    WVST
]

# This list has all the models which will be used when attempting to
# guess an isotherm model. They are the ones where the fitting
# is fast enough to be acceptable
_GUESS_MODELS = [
    Henry,
    Langmuir,
    DSLangmuir,
    DR,
    Freundlich,
    Quadratic,
    BET,
    TemkinApprox,
    Toth,
    JensenSeaton
]

# This list has all the models which work with IAST.
# This is required as some models (such as Freundlich)
# are not physically consistent.
_IAST_MODELS = [
    Henry,
    Langmuir,
    DSLangmuir,
    TSLangmuir,
    Quadratic,
    BET,
    TemkinApprox,
    Toth,
    JensenSeaton
]


def get_isotherm_model(model_name):
    """
    Check whether specified model name exists and return an instance of that model class.

    Parameters
    ----------
    model_name : str
        The name of the requested model

    Returns
    -------
    ModelIsotherm
        A specific model

    Raises
    ------
    ParameterError
        When the model does not exist
    """
    for _model in _MODELS:
        if model_name == _model.name:
            return _model()

    raise ParameterError("Model {0} not an option. Viable models "
                         "are {1}.".format(model_name, [model.name for model in _MODELS]))


def is_iast_model(model_name):
    """
    Check whether specified model can be used with IAST.

    Parameters
    ----------
    model_name : str
        The name of the model

    Returns
    -------
    bool
        Whether it is applicable or not.

    """
    return model_name in [model.name for model in _IAST_MODELS]


def is_base_model(model):
    """
    Check whether the input is derived from the base model.

    Parameters
    ----------
    model : Model
        A derived IsothermBaseModel class

    Returns
    -------
    bool
        True or false.

    """
    return isinstance(model, IsothermBaseModel)
# pylint: disable=W0614,W0401,W0611,W0622 # flake8: noqa Lists all isotherm models which are available.  If adding a custom model, it should be also added below. # This list has all the available models # This list has all the models which will be used when attempting to # guess an isotherm model. They are the ones where the fitting # is fast enough to be acceptable # This list has all the models which work with IAST. # This is required as some models (such as Freundlich) # are not physically consistent. Check whether specified model name exists and return an instance of that model class.      Parameters     ----------     model_name : str         The name of the requested model      Returns     -------     ModelIsotherm         A specific model      Raises     ------     ParameterError         When the model does not exist Check whether specified model can be used with IAST.      Parameters     ----------     model_name : str         The name of the model      Returns     -------     bool         Whether it is applicable or not. Check whether the input is derived from the base model.      Parameters     ----------     model : Model         A derived IsothermBaseModel class      Returns     -------     bool         True or false.