Source code for gemseo.mda.base_mda_root_settings

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
"""Base settings class for MDAs based on root finding algorithms."""

from __future__ import annotations

from pydantic import Field

from gemseo.mda.base_parallel_mda_settings import BaseParallelMDASettings




class BaseMDARootSettings(BaseParallelMDASettings):
    """The settings for MDAs based on root finding algorithms."""

    execute_before_linearizing: bool = Field(
        default=True,
        description="""Whether to start by executing the disciplines before linearizing.

This ensures that the discipline are executed and linearized with the same input data.
It can be almost free
if the corresponding output data have been stored in the :attr:`.BaseMDA.cache`.""",
    )