Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Rythmos_BreakPointInformerBase.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#ifndef Rythmos_BREAK_POINT_INFORMER_H
30#define Rythmos_BREAK_POINT_INFORMER_H
31
32namespace Rythmos {
33
35template<class Scalar>
37 : virtual public Teuchos::Describable
38 , virtual public Teuchos::ParameterListAcceptor
39 , virtual public Teuchos::VerboseObject<BreakPointInformerBase<Scalar> >
40{
41 public:
47 virtual bool testForBreakPoint(Scalar& time0, Scalar& dt) const =0;
48
54 virtual Scalar getNextBreakPoint(Scalar& time0) const =0;
55
60 virtual void removeNextBreakPoint(Scalar& time0) =0;
61
62};
63
64} // namespace Rythmos
65
66#endif //Rythmos_BREAK_POINT_INFORMER_H
virtual Scalar getNextBreakPoint(Scalar &time0) const =0
Get next break point.
virtual void removeNextBreakPoint(Scalar &time0)=0
Remove breakpoint from list.
virtual bool testForBreakPoint(Scalar &time0, Scalar &dt) const =0
Basic breakpoint interface.