/usr/include/libmesh/transient.h is in libmesh-dev 0.7.1-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | // $Id: transient.h 3874 2010-07-02 21:57:26Z roystgnr $
// The libMesh Finite Element Library.
// Copyright (C) 2002-2008 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#ifndef __transient_h__
#define __transient_h__
// C++ includes
// Local includes
#include "libmesh_common.h"
#include "linear.h"
namespace libMesh
{
/**
* This is a generic class that defines a transient to be used in a
* simulation. A user can define a transient by deriving from this
* class and implementing certain functions.
*
* @author Benjamin S. Kirk, 2003-2004.
*/
// ------------------------------------------------------------
// Transient class definition
template <class T = Linear<> >
class Transient : public T
{
public:
/**
* Constructor. Requires a reference to a system to be solved.
*/
Transient (EquationSystems& es);
/**
* Constructor. Requires a referece to the \p EquationSystems object.
*/
Transient (EquationSystems& es,
const std::string& name,
const unsigned int number);
/**
* Destructor.
*/
~Transient ();
/**
* Re-implement the solve member to do solve a transient system.
*/
virtual void solve ();
/**
* @returns the current time.
*/
Real time () const { return _time; }
/**
* @returns the target simulation time.
*/
Real t_end () const { return _t_end; }
/**
* Sets the target simulation time.
*/
Real & t_end () { return _t_end; }
/**
* @returns the time step used to advance the solution.
*/
Real dt () const { return _dt; }
/**
* Set the time step.
*/
Real & dt () { return _dt; }
/**
* @returns the current time step (0,1,2...)
*/
unsigned int time_step () const { return _time_step; }
/**
* @returns the maximum number of time steps to take.
*/
unsigned int max_time_steps () const { return _max_time_steps; }
/**
* Sets the maximum number of time steps to take.
*/
unsigned int & max_time_steps () { return _max_time_steps; }
protected:
/**
* Set the current time.
* Only to be used by this and derived classes.
*/
Real & time () { return _time; }
/**
* Set the current time step.
* Only to be used by this and derived classes.
*/
unsigned int & time_step () { return _time_step; }
private:
/**
* The current time.
*/
Real _time;
/**
* The time at which the simulation will be terminated.
*/
Real _t_end;
/**
* The time incriment used to advance the solution.
*/
Real _dt;
/**
* The current time step.
*/
unsigned int _time_step;
/**
* The maximum number of time steps to take.
*/
unsigned int _max_time_steps;
};
// ------------------------------------------------------------
// Transient inline members
template <class T>
inline
Transient<T>::Transient(EquationSystems& es) :
T (es), // Call the base class constructor
_time (0.), // Default solver attributes
_t_end (1.e20),
_dt (1.e-2),
_time_step (0),
_max_time_steps (5)
{
libmesh_deprecated();
}
template <class T>
inline
Transient<T>::Transient (EquationSystems& es,
const std::string& name,
const unsigned int number) :
Transient (es),
T (es, name, number)
{
libmesh_deprecated();
}
template <class T>
inline
Transient<T>::~Transient ()
{
}
template <class T>
inline
void Transient<T>::solve ()
{
do
{
// Incriment the time step counter
this->time_step()++;
// Incriment the time counter
this->time() += this->dt();
libMesh::out << "Solving time step "
<< this->time_step()
<< std::endl;
// Call the base class solver
T::solve ();
}
while ((this->time_step() < this->max_time_steps()) &&
(this->time() < this->t_end()));
}
} // namespace libMesh
#endif // #define __transient_h__
|