Homec4science
Diffusion SpecMiCP / ReactMiCP (master) Browse

specmicp/src/specmicp/adimensional/adimensional_system_solver_structs.hpp
b174f1ddf352master

Last Change
Raw File

adimensional_system_solver_structs.hpp
View Options

/*-------------------------------------------------------------------------------
Copyright (c) 2014,2015 F. Georget <fabieng@princeton.edu>, Princeton University
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-----------------------------------------------------------------------------*/
#ifndef SPECMICP_SPECMICP_ADIMENSIONALSYSTEMSOLVERSTRUCTS_HPP
#define SPECMICP_SPECMICP_ADIMENSIONALSYSTEMSOLVERSTRUCTS_HPP
#include "common.hpp"
#include "micpsolver/micpsolver_structs.hpp"
#include "adimensional_system_structs.hpp"
#include "physics/units.hpp"
//! \file adimensional_system_solver_structs.hpp Options and conditions for AdimensionalSystemSolver
namespace specmicp {
//! \struct AdimensionalSystemSolverOptions
//! \brief Options for the Equilibrium solver
//!
//! Most of the options are contained in the MiCP solver options or the AdimensionalSystem options
struct AdimensionalSystemSolverOptions
{
micpsolver::MiCPSolverOptions solver_options; //!< Options of the MiCP solver
AdimensionalSystemOptions system_options; //!< Options of the system
bool allow_restart; //!< Allow the restarting if the problem failed the first part
units::UnitsSet units_set; //!< Set of units
bool use_pcfm; //!< If true use the pcfm method to initialize the problem
bool force_pcfm; //!< Use pcfm before every trial
AdimensionalSystemSolverOptions():
solver_options(), // default options of the solver
system_options(), // default options of the system
allow_restart(true),
use_pcfm(false),
force_pcfm(false)
{
// disable the descent condition check
solver_options.disable_descent_direction();
}
};
} // end namespace specmicp
#endif //SPECMICP_SPECMICP_ADIMENSIONALSYSTEMSOLVERSTRUCTS_HPP
c4science · Help