// National Technology & Engineering Solutions of Sandia, LLC (NTESS)
//
// Under the terms of Contract DE-NA0003525 with NTESS, the
// U.S. Government retains certain rights in this software.
//
// Pressio is licensed under BSD-3-Clause terms of use:
//
// 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.
//
// Questions? Contact Francesco Rizzi (fnrizzi@sandia.gov)
//
// ************************************************************************
//@HEADER
*/
#ifndef PRESSIOROM_ODE_CONCEPTS_ODE_SYSTEM_HPP_
#define PRESSIOROM_ODE_CONCEPTS_ODE_SYSTEM_HPP_
#include "ode_predicates_for_system.hpp"
#include "ode_has_const_discrete_residual_jacobian_method.hpp"
namespace pressio{ namespace ode{
template<class T, class enable = void>
struct OdeSystem : std::false_type{};
template<class T>
struct OdeSystem<
T,
std::enable_if_t<
::pressio::has_independent_variable_typedef<T>::value
&& ::pressio::has_state_typedef<T>::value
&& ::pressio::has_rhs_typedef<T>::value
&& std::is_copy_constructible<typename T::state_type>::value
&& std::is_copy_constructible<typename T::rhs_type>::value
&& ::pressio::ode::has_const_create_state_method_return_result<
T, typename T::state_type >::value
&& ::pressio::ode::has_const_create_rhs_method_return_result<
T, typename T::rhs_type >::value
&& std::is_void<
decltype(
std::declval<T const>().rhs
(
std::declval<typename T::state_type const&>(),
std::declval<typename T::independent_variable_type const &>(),
std::declval<typename T::rhs_type &>()
)
)
>::value
>
> : std::true_type{};
template<class T, class enable = void>
struct OdeSystemFusingRhsAndJacobian : std::false_type{};
template<class T>
struct OdeSystemFusingRhsAndJacobian<
T,
std::enable_if_t<
::pressio::has_independent_variable_typedef<T>::value
&& ::pressio::has_state_typedef<T>::value
&& ::pressio::has_rhs_typedef<T>::value
&& ::pressio::has_jacobian_typedef<T>::value
&& std::is_copy_constructible<typename T::state_type>::value
&& std::is_copy_constructible<typename T::rhs_type>::value
&& std::is_copy_constructible<typename T::jacobian_type>::value
&& ::pressio::ode::has_const_create_state_method_return_result<
T, typename T::state_type >::value
&& ::pressio::ode::has_const_create_rhs_method_return_result<
T, typename T::rhs_type >::value
&& ::pressio::ode::has_const_create_jacobian_method_return_result<
T, typename T::jacobian_type >::value
&& std::is_void<
decltype(
std::declval<T const>().rhsAndJacobian
(
std::declval<typename T::state_type const&>(),
std::declval<typename T::independent_variable_type const &>(),
std::declval<typename T::rhs_type &>(),
std::declval< std::optional<typename T::jacobian_type*> >()
)
)
>::value
>
> : std::true_type{};
template<class T, class enable = void>
struct OdeSystemFusingMassMatrixAndRhs : std::false_type{};
template<class T>
struct OdeSystemFusingMassMatrixAndRhs<
T,
std::enable_if_t<
::pressio::has_independent_variable_typedef<T>::value
&& ::pressio::has_state_typedef<T>::value
&& ::pressio::has_rhs_typedef<T>::value
&& ::pressio::has_mass_matrix_typedef<T>::value
&& std::is_copy_constructible<typename T::state_type>::value
&& std::is_copy_constructible<typename T::rhs_type>::value
&& std::is_copy_constructible<typename T::mass_matrix_type>::value
&& ::pressio::ode::has_const_create_state_method_return_result<
T, typename T::state_type >::value
&& ::pressio::ode::has_const_create_rhs_method_return_result<
T, typename T::rhs_type >::value
&& ::pressio::ode::has_const_create_mass_matrix_method_return_result<
T, typename T::mass_matrix_type >::value
//
&& std::is_void<
decltype(
std::declval<T const>().massMatrixAndRhs
(
std::declval<typename T::state_type const&>(),
std::declval<typename T::independent_variable_type const &>(),
std::declval<typename T::mass_matrix_type &>(),
std::declval<typename T::rhs_type &>()
)
)
>::value
>
> : std::true_type{};
template<class T, class enable = void>
struct CompleteOdeSystem : std::false_type{};
template<class T>
struct CompleteOdeSystem<
T,
std::enable_if_t<
::pressio::has_independent_variable_typedef<T>::value
&& ::pressio::has_state_typedef<T>::value
&& ::pressio::has_rhs_typedef<T>::value
&& ::pressio::has_mass_matrix_typedef<T>::value
&& ::pressio::has_jacobian_typedef<T>::value
&& std::is_copy_constructible<typename T::state_type>::value
&& std::is_copy_constructible<typename T::rhs_type>::value
&& std::is_copy_constructible<typename T::mass_matrix_type>::value
&& std::is_copy_constructible<typename T::jacobian_type>::value
&& ::pressio::ode::has_const_create_state_method_return_result<
T, typename T::state_type >::value
&& ::pressio::ode::has_const_create_rhs_method_return_result<
T, typename T::rhs_type >::value
&& ::pressio::ode::has_const_create_mass_matrix_method_return_result<
T, typename T::mass_matrix_type >::value
&& ::pressio::ode::has_const_create_jacobian_method_return_result<
T, typename T::jacobian_type >::value
//
&& std::is_void<
decltype(
std::declval<T const>().massMatrixAndRhsAndJacobian
(
std::declval<typename T::state_type const&>(),
std::declval<typename T::independent_variable_type const &>(),
std::declval<typename T::mass_matrix_type &>(),
std::declval<typename T::rhs_type &>(),
std::declval< std::optional<typename T::jacobian_type*> >()
)
)
>::value
>
> : std::true_type{};
template<class T, int NumStates,class enable = void>
struct FullyDiscreteSystemWithJacobian : std::false_type{};
template<class T, int NumStates>
struct FullyDiscreteSystemWithJacobian<
T, NumStates,
std::enable_if_t<
::pressio::has_independent_variable_typedef<T>::value
&& ::pressio::has_state_typedef<T>::value
&& ::pressio::has_discrete_residual_typedef<T>::value
&& ::pressio::has_discrete_jacobian_typedef<T>::value
&& std::is_copy_constructible<typename T::state_type>::value
&& std::is_copy_constructible<typename T::discrete_residual_type>::value
&& std::is_copy_constructible<typename T::discrete_jacobian_type>::value
&& ::pressio::ode::has_const_create_state_method_return_result<
T, typename T::state_type >::value
&& ::pressio::ode::has_const_create_discrete_residual_method_return_result<
T, typename T::discrete_residual_type>::value
&& ::pressio::ode::has_const_create_discrete_jacobian_method_return_result<
T, typename T::discrete_jacobian_type>::value
//
&& ::pressio::ode::has_const_discrete_residual_jacobian_method<
T, NumStates,
typename ::pressio::ode::StepCount::value_type,
typename T::independent_variable_type,
typename T::state_type,
typename T::discrete_residual_type,
typename T::discrete_jacobian_type
>::value
>
> : std::true_type{};
//
// refine for real-valued case
//
template<class T, class enable = void>
struct RealValuedOdeSystem : std::false_type{};
template<class T>
struct RealValuedOdeSystem<
T, std::enable_if_t<
OdeSystem<T>::value
&& std::is_floating_point< scalar_trait_t<typename T::state_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::rhs_type> >::value
&& std::is_convertible<
typename T::independent_variable_type,
scalar_trait_t<typename T::state_type> >::value
>
> : std::true_type{};
template<class T, class enable = void>
struct RealValuedOdeSystemFusingRhsAndJacobian : std::false_type{};
template<class T>
struct RealValuedOdeSystemFusingRhsAndJacobian<
T,
std::enable_if_t<
OdeSystemFusingRhsAndJacobian<T>::value
&& std::is_floating_point< scalar_trait_t<typename T::state_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::rhs_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::jacobian_type> >::value
&& std::is_convertible<
typename T::independent_variable_type,
scalar_trait_t<typename T::state_type> >::value
> > : std::true_type{};
template<class T, class enable = void>
struct RealValuedOdeSystemFusingMassMatrixAndRhs : std::false_type{};
template<class T>
struct RealValuedOdeSystemFusingMassMatrixAndRhs<
T, std::enable_if_t<
OdeSystemFusingMassMatrixAndRhs<T>::value
&& std::is_floating_point< scalar_trait_t<typename T::state_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::rhs_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::mass_matrix_type> >::value
&& std::is_convertible<
typename T::independent_variable_type,
scalar_trait_t<typename T::state_type> >::value
>
> : std::true_type{};
template<class T, class enable = void>
struct RealValuedCompleteOdeSystem : std::false_type{};
template<class T>
struct RealValuedCompleteOdeSystem<
T, std::enable_if_t<
CompleteOdeSystem<T>::value
&& std::is_floating_point< scalar_trait_t<typename T::state_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::rhs_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::mass_matrix_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::jacobian_type> >::value
&& std::is_convertible<
typename T::independent_variable_type,
scalar_trait_t<typename T::state_type> >::value
>
> : std::true_type{};
template <class T, int NumStates, class = void>
struct RealValuedFullyDiscreteSystemWithJacobian : std::false_type{};
template <class T, int NumStates>
struct RealValuedFullyDiscreteSystemWithJacobian<
T, NumStates,
std::enable_if_t<
FullyDiscreteSystemWithJacobian<T, NumStates>::value
&& std::is_floating_point< scalar_trait_t<typename T::state_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::discrete_residual_type> >::value
&& std::is_floating_point< scalar_trait_t<typename T::discrete_jacobian_type> >::value
&& std::is_convertible<
typename T::independent_variable_type,
scalar_trait_t<typename T::state_type> >::value
>
> : std::true_type{};
//
// policy
//
template<class T, class = void>
struct ImplicitResidualJacobianPolicy : std::false_type{};
template<class T>
struct ImplicitResidualJacobianPolicy<
T,
std::enable_if_t<
::pressio::has_independent_variable_typedef<T>::value
&& ::pressio::has_state_typedef<T>::value
&& ::pressio::has_residual_typedef<T>::value