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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
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>::setInitialCondition(
00082   const Thyra::ModelEvaluatorBase::InArgs<Scalar> &initialCondition
00083   )
00084 {
00085   TEST_FOR_EXCEPTION(
00086     true, std::logic_error,
00087     "Error, the function setIntialCondition(...) is not implemented\n"
00088     "in the class \"" << Teuchos::typeName(*this) << "\"!" );
00089   // ToDo: Remove this default implementation and make every concrete
00090   // subclass implement this!
00091 }
00092 
00093 template<class Scalar>
00094 void StepperBase<Scalar>::setStepControlData(const StepperBase & stepper)
00095 {
00096 }
00097 
00098 
00099 // 
00100 // Explicit Instantiation macro
00101 //
00102 // Must be expanded from within the Rythmos namespace!
00103 //
00104 
00105 #define RYTHMOS_STEPPER_BASE_INSTANT(SCALAR) \
00106   \
00107   template class StepperBase< SCALAR >; \
00108   \
00109   template bool isInitialized( const StepperBase< SCALAR >& stepper );
00110    
00111 
00112 } // namespace Rythmos
00113 
00114 #endif //Rythmos_STEPPER_BASE_DEF_H

Generated on Wed May 12 21:25:44 2010 for Rythmos - Transient Integration for Differential Equations by  doxygen 1.4.7