Skip to content

Commit

Permalink
#707: add check for eigen-only operation
Browse files Browse the repository at this point in the history
  • Loading branch information
cwschilly committed Nov 13, 2024
1 parent a34b642 commit ffb3205
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 7 deletions.
34 changes: 27 additions & 7 deletions include/pressio/ode/impl/ode_implicit_discrete_jacobian.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@

namespace pressio{ namespace ode{ namespace impl{

/*
throws if add_to_diagonal is not defined for
given container type
*/
template <class JacobianType, class StepSizeType>
void discrete_jacobian(::pressio::ode::BDF1,
JacobianType & jac,
const StepSizeType & dt)
{
throw std::runtime_error("missing implementation");
}

/*
BDF1: J(y_n+1) = I - dt*df_n+1/dy_n+1
on input jac contains df_n+1/dy_n+1
Expand All @@ -60,13 +72,15 @@ template <class JacobianType, class StepSizeType>
std::enable_if_t<
std::is_convertible<
StepSizeType, typename Traits<JacobianType>::scalar_type
>::value
>
>::value &&
ode::has_add_to_diagonal_operation<
JacobianType, const typename Traits<JacobianType>::scalar_type
>::value
>
discrete_jacobian(::pressio::ode::BDF1,
JacobianType & jac,
const StepSizeType & dt)
{

using sc_t = typename ::pressio::Traits<JacobianType>::scalar_type;
constexpr sc_t cnp1 = ::pressio::ode::constants::bdf1<sc_t>::c_np1_;
const sc_t cf = ::pressio::ode::constants::bdf1<sc_t>::c_f_ * dt;
Expand Down Expand Up @@ -107,8 +121,11 @@ template <class JacobianType, class StepSizeType>
std::enable_if_t<
std::is_convertible<
StepSizeType, typename Traits<JacobianType>::scalar_type
>::value
>
>::value &&
ode::has_add_to_diagonal_operation<
JacobianType, const typename Traits<JacobianType>::scalar_type
>::value
>
discrete_jacobian(::pressio::ode::BDF2,
JacobianType & jac,
const StepSizeType & dt)
Expand Down Expand Up @@ -155,8 +172,11 @@ template <class JacobianType, class StepSizeType>
std::enable_if_t<
std::is_convertible<
StepSizeType, typename Traits<JacobianType>::scalar_type
>::value
>
>::value &&
ode::has_add_to_diagonal_operation<
JacobianType, const typename Traits<JacobianType>::scalar_type
>::value
>
discrete_jacobian(::pressio::ode::CrankNicolson,
JacobianType & jac,
const StepSizeType & dt)
Expand Down
75 changes: 75 additions & 0 deletions include/pressio/ode/ode_predicates.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
//@HEADER
// ************************************************************************
//
// ode_predicates.hpp
// Pressio
// Copyright 2019
// 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 ([email protected])
//
// ************************************************************************
//@HEADER
*/

#ifndef PRESSIO_ODE_ODE_PREDICATES_HPP_
#define PRESSIO_ODE_ODE_PREDICATES_HPP_

#include <type_traits>

namespace pressio{ namespace ode{

template <class T, class ScalarType, class = void>
struct has_add_to_diagonal_operation : std::false_type{};

template <class T, class ScalarType>
struct has_add_to_diagonal_operation<
T, ScalarType,
std::enable_if_t<
std::is_void<
decltype(
::pressio::ops::add_to_diagonal(
std::declval<T &>(),
std::declval<const ScalarType &>()
)
)
>::value
>
> : std::true_type{};

}} // namespace pressio::ode
#endif // PRESSIO_ODE_ODE_PREDICATES_HPP
1 change: 1 addition & 0 deletions include/pressio/ode_steppers_implicit.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
#include "./ode/ode_strong_types.hpp"
#include "./ode/ode_constants.hpp"
#include "./ode/ode_enum_and_tags.hpp"
#include "./ode/ode_predicates.hpp"
#include "./ode/ode_create_implicit_stepper.hpp"

#endif

0 comments on commit ffb3205

Please sign in to comment.