Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/reactmicp/systems/common/equilibrium_options_vector.hpp
773188cd2fbechloride

Last Change
Raw File

equilibrium_options_vector.hpp
View Options

/* =============================================================================
Copyright (c) 2014-2017 F. Georget <fabieng@princeton.edu> Princeton University
Copyright (c) 2017-2018 F. Georget <fabien.georget@epfl.ch> EPFL
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_REACTMICP_COMMON_EQUILIBRIUMOPTIONSVECTOR_HPP
#define SPECMICP_REACTMICP_COMMON_EQUILIBRIUMOPTIONSVECTOR_HPP
#include "specmicp_common/macros.hpp"
#include "specmicp_common/cached_vector.hpp"
#include "specmicp/adimensional/adimensional_system_solver_structs.hpp"
#include <memory>
//! \file reactmicp/systems/common/equilibrium_options_vector.hpp
//! \brief Set of options for the chemistry staggers
namespace specmicp {
namespace reactmicp {
namespace systems {
//! \brief The vector of options for SpecMiCP solver
//!
//! Same set of options can be used for several cells
class SPECMICP_DLL_PUBLIC EquilibriumOptionsVector:
public utils::NameCachedVector<AdimensionalSystemSolverOptions>
{
// It is defined as its own class to simplify the use of the API
public:
//! \brief Default constructor
//!
//! \deprecated
EquilibriumOptionsVector();
//! \brief Constructor with default value
EquilibriumOptionsVector(
size_type size,
std::string name,
AdimensionalSystemSolverOptions& value
);
//! \brief Constructor with no value
EquilibriumOptionsVector(
size_type size,
std::string name
);
//! \brief Build a default EquilibriumOptionsVector
static std::shared_ptr<EquilibriumOptionsVector>
make(index_t nb_nodes, std::string name="default") {
return std::make_shared<EquilibriumOptionsVector>(nb_nodes, name);
}
};
} // namespace systems
} // namespace reactmicp
} // namespace specmicp
#endif // SPECMICP_REACTMICP_COMMON_EQUILIBRIUMOPTIONSVECTOR_HPP
c4science · Help