Rythmos - Transient Integration for Differential Equations Version of the Day
Rythmos_StepperBase_def.hpp
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //                           Rythmos Package
00005 //                 Copyright (2006) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
00023 // USA
00024 // Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 //@HEADER
00028 
00029 #ifndef Rythmos_STEPPER_BASE_DEF_H
00030 #define Rythmos_STEPPER_BASE_DEF_H
00031 
00032 #include "Rythmos_StepperBase_decl.hpp"
00033 
00034 namespace Rythmos {
00035 
00040 template<class Scalar>
00041 bool isInitialized( const StepperBase<Scalar>& stepper )
00042 {
00043   return stepper.getTimeRange().isValid();
00044 }
00045 
00046 
00047 // ///////////////////////////////
00048 // Implementations
00049 
00050 
00051 template<class Scalar>
00052 bool StepperBase<Scalar>::isImplicit() const
00053 {
00054   return false;
00055 }
00056 
00057 
00058 template<class Scalar>
00059 bool StepperBase<Scalar>::acceptsModel() const
00060 {
00061   return true;
00062 }
00063 
00064 
00065 template<class Scalar>
00066 bool StepperBase<Scalar>::supportsCloning() const
00067 {
00068   return false;
00069 }
00070 
00071 
00072 template<class Scalar>
00073 RCP<StepperBase<Scalar> >
00074 StepperBase<Scalar>::cloneStepperAlgorithm() const
00075 {
00076   return Teuchos::null;
00077 }
00078 
00079 
00080 template<class Scalar>
00081 void StepperBase<Scalar>::setStepControlData(const StepperBase & stepper)
00082 {
00083   // 2009/08/31: rabartl ToDo: Should this really be left empty?
00084 }
00085 
00086 
00087 // 
00088 // Explicit Instantiation macro
00089 //
00090 // Must be expanded from within the Rythmos namespace!
00091 //
00092 
00093 #define RYTHMOS_STEPPER_BASE_INSTANT(SCALAR) \
00094   \
00095   template class StepperBase< SCALAR >; \
00096   \
00097   template bool isInitialized( const StepperBase< SCALAR >& stepper );
00098    
00099 
00100 } // namespace Rythmos
00101 
00102 #endif //Rythmos_STEPPER_BASE_DEF_H
 All Classes Functions Variables Typedefs Friends