Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Rythmos_RKButcherTableauBase.hpp
1//@HEADER
2// ***********************************************************************
3//
4// Rythmos Package
5// Copyright (2006) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// This library is free software; you can redistribute it and/or modify
11// it under the terms of the GNU Lesser General Public License as
12// published by the Free Software Foundation; either version 2.1 of the
13// License, or (at your option) any later version.
14//
15// This library is distributed in the hope that it will be useful, but
16// WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18// Lesser General Public License for more details.
19//
20// You should have received a copy of the GNU Lesser General Public
21// License along with this library; if not, write to the Free Software
22// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23// USA
24// Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
25//
26// ***********************************************************************
27//@HEADER
28
29
30#ifndef RYTHMOS_RK_BUTCHER_TABLEAU_BASE_HPP
31#define RYTHMOS_RK_BUTCHER_TABLEAU_BASE_HPP
32
33#include "Rythmos_Types.hpp"
34#include "Teuchos_Describable.hpp"
35#include "Teuchos_ParameterListAcceptor.hpp"
36#include "Teuchos_VerboseObject.hpp"
37#include "Teuchos_SerialDenseMatrix.hpp"
38#include "Teuchos_SerialDenseVector.hpp"
39
40namespace Rythmos {
41
42/* \brief . */
43template<class Scalar>
44class RKButcherTableauBase :
45 virtual public Teuchos::Describable,
46 virtual public Teuchos::ParameterListAcceptor,
47 virtual public Teuchos::VerboseObject<RKButcherTableauBase<Scalar> >
48{
49public:
51 virtual int numStages() const = 0;
53 virtual const Teuchos::SerialDenseMatrix<int,Scalar>& A() const = 0;
55 virtual const Teuchos::SerialDenseVector<int,Scalar>& b() const = 0;
57 virtual const Teuchos::SerialDenseVector<int,Scalar>& bhat() const = 0;
59 virtual const Teuchos::SerialDenseVector<int,Scalar>& c() const = 0;
61 virtual int order() const = 0;
63 virtual bool isEmbeddedMethod() const = 0;
65 virtual bool operator== (const RKButcherTableauBase<Scalar>& rkbt) const;
67 virtual void setDescription(std::string longDescription) = 0;
68};
69
70
71/* \brief . */
72template<class Scalar>
73bool RKButcherTableauBase<Scalar>::operator== (const RKButcherTableauBase<Scalar>& rkbt) const
74{
75 if (this->numStages() != rkbt.numStages()) {
76 return false;
77 }
78 if (this->order() != rkbt.order()) {
79 return false;
80 }
81 int N = rkbt.numStages();
82 // Check b and c first:
83 const Teuchos::SerialDenseVector<int,Scalar> b_ = this->b();
84 const Teuchos::SerialDenseVector<int,Scalar> c_ = this->c();
85 const Teuchos::SerialDenseVector<int,Scalar> other_b = rkbt.b();
86 const Teuchos::SerialDenseVector<int,Scalar> other_c = rkbt.c();
87 for (int i=0 ; i<N ; ++i) {
88 if (b_(i) != other_b(i)) {
89 return false;
90 }
91 if (c_(i) != other_c(i)) {
92 return false;
93 }
94 }
95 // Then check A:
96 const Teuchos::SerialDenseMatrix<int,Scalar>& A_ = this->A();
97 const Teuchos::SerialDenseMatrix<int,Scalar>& other_A = rkbt.A();
98 for (int i=0 ; i<N ; ++i) {
99 for (int j=0 ; j<N ; ++j) {
100 if (A_(i,j) != other_A(i,j)) {
101 return false;
102 }
103 }
104 }
105 return true;
106}
107
108} // namespace Rythmos
109
110
111#endif // RYTHMOS_RK_BUTCHER_TABLEAU_BASE_HPP