/usr/include/lorene/C++/Include/evolution.h is in liblorene-dev 0.0.0~cvs20161116+dfsg-1ubuntu4.
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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | /*
* Definition of Lorene template classes Evolution, Evolution_full
* and Evolution_std
*
*/
/*
* Copyright (c) 2004 Eric Gourgoulhon & Jerome Novak
*
* This file is part of LORENE.
*
* LORENE is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* LORENE 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with LORENE; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef __EVOLUTION_H_
#define __EVOLUTION_H_
/*
* $Id: evolution.h,v 1.15 2014/10/13 08:52:34 j_novak Exp $
* $Log: evolution.h,v $
* Revision 1.15 2014/10/13 08:52:34 j_novak
* Lorene classes and functions now belong to the namespace Lorene.
*
* Revision 1.14 2014/03/27 16:59:41 j_novak
* Added methods next_position(int) and previous_position(int). Changed (corrected + simplified) the interpolation method.
*
* Revision 1.13 2013/07/19 15:50:24 j_novak
* Implementation of the interpolation function for Evolution, with order=0, 1 or 2.
*
* Revision 1.12 2004/11/26 09:28:50 p_grandclement
* using in Derived templates are now public
*
* Revision 1.11 2004/11/25 07:53:53 e_gourgoulhon
* Added directives
* using Evolution<TyT>::...
* to comply with g++ 3.4.
*
* Revision 1.10 2004/05/11 20:11:49 e_gourgoulhon
* Class Evolution:
* -- suppressed method get_jtop()
* -- added methods j_min(), j_max() and save().
*
* Revision 1.9 2004/03/26 13:31:08 j_novak
* Definition of the macro UNDEF_STEP for non-defined time-steps.
* Changes in the way the time derivative is calculated.
*
* Revision 1.8 2004/03/26 08:22:12 e_gourgoulhon
* *** Full reorganization of class Evolution ***
* Introduction of the notion of absoluteuniversal time steps,
* stored in the new array 'step'.
* The new function position(int j) makes a correspondence
* between a universal time step j and the position in the
* arrays step, the_time and val.
* Only method update is now virtual.
* Methods operator[], position, is_known, downdate belong to
* the base class.
*
* Revision 1.7 2004/03/24 14:55:46 e_gourgoulhon
* Added method last_value().
*
* Revision 1.6 2004/03/23 14:50:40 e_gourgoulhon
* Added methods is_updated, downdate, get_jlast, get_size,
* as well as constructors without any initial value.
* Formatted documentation for Doxygen.
*
* Revision 1.5 2004/03/06 21:13:13 e_gourgoulhon
* Added time derivation (method time_derive).
*
* Revision 1.4 2004/02/16 17:37:17 j_novak
* Arguments named for doc++.
*
* Revision 1.3 2004/02/16 10:36:03 e_gourgoulhon
* Replaced " = 0x0" by " = 0" in the declaration of pure virtual functions.
*
* Revision 1.2 2004/02/15 21:55:32 e_gourgoulhon
* Introduced derived classes Evolution_full and Evolution_std.
* Evolution is now an abstract base class.
*
* Revision 1.1 2004/02/13 15:53:20 e_gourgoulhon
* New (template) class for time evolution.
*
*
*
*
* $Header: /cvsroot/Lorene/C++/Include/evolution.h,v 1.15 2014/10/13 08:52:34 j_novak Exp $
*
*/
#define UNDEF_STEP -100000
//---------------------------//
// Class Evolution //
//---------------------------//
namespace Lorene {
/** Time evolution (*** under development ***). \ingroup (evol)
*
* The template class \c Evolution has been devised to store and
* manipulate evolving quantities of any type, for instance \c TyT = \c double
* or \c TyT = \c Scalar.
*
* \c Evolution is an abstract base class for classes
* \c Evolution_full and \c Evolution_std.
*
*/
template<typename TyT> class Evolution {
// Data:
// -----
protected:
/// Maximum number of stored time steps.
int size ;
/// Array of time step indices (size = \c size).
int* step ;
/// Array of values of t at the various time steps (size = \c size).
double* the_time ;
/// Array of pointers onto the values (size = \c size).
TyT** val ;
/** Position in the arrays \c step, \c the_time and \c val
* of the most evolved time step.
*/
int pos_jtop ;
// Constructors - Destructor
// -------------------------
protected:
/** Constructor from some initial value.
*
*/
Evolution(const TyT& initial_value, int initial_j,
double initial_time, int initial_size) ;
/** Constructor without any initial value.
*/
Evolution(int initial_size) ;
Evolution(const Evolution<TyT>& t_in) ; ///< Copy constructor
public:
virtual ~Evolution() ; ///< Destructor
// Mutators
// --------
public:
/** Sets a new value at a given time step.
*/
virtual void update(const TyT& new_value, int j,
double time_j) = 0 ;
/** Suppresses a stored value.
*/
void downdate(int j) ;
/// Assignement
virtual void operator=(const Evolution<TyT>& t_in) ;
// Accessors
// ---------
protected:
/** Gives the position in the arrays \c step, \c the_time and
* \c val corresponding to the time step j
*/
int position(int j) const ;
/// Returns the next valid position (returns -1 if none is found)
int next_position(int i) const ;
/// Returns the previous valid position (returns -1 if none is found)
int previous_position(int i) const ;
public:
/// Returns the value at time step j
const TyT& operator[](int j) const ;
/// Returns the time t at time step j
double get_time(int j) const {return the_time[position(j)];} ;
/// Returns the value at time t, with a scheme of order \c order.
TyT operator()(double t, int order=2) const ;
/// Returns the member \c size
int get_size() const {return size; } ;
/// Returns the smaller time step j stored in \c *this
int j_min() const ;
/// Returns the larger time step j stored in \c *this
int j_max() const ;
/** Checks whether the value a given time step has been set
* @param j time step index
* @return \c true if the value at time step j is known, \c false
* otherwise
*/
bool is_known(int j) const ;
// Computational methods
// ---------------------
/** Computes the time derivative at time step \c j by means of a
* n-th order scheme, from the values at steps \c j,
* \c j-1, ..., \c j-n.
*
* @param j [input] : value of the time step at which the time
* derivative is required
* @param n [input] : order of the time scheme (default value=2);
* if n=0, then the \c Evolution is considered
* to be stationary and a null value is returned.
* @return time derivative at time step \c j
*
*/
TyT time_derive(int j, int n = 2) const ;
// Outputs
// -------
/** Saves \c *this in a formatted file.
* If \c TyT = \c double, this file is readable by 2-D plotting
* software (e.g. \e Xmgrace) to produce a curve of the time
* evolution.
* @param filename name of the file: this file will be created
* in the working directory.
*/
void save(const char* filename) const ;
};
//---------------------------//
// Class Evolution_full //
//---------------------------//
/** Time evolution with full storage (*** under development ***).
* \ingroup (evol)
*
* The template class \c Evolution_full has been devised to store and
* manipulate evolving quantities of any type, for instance \c TyT = \c double
* or \c TyT = \c Scalar.
* The quantity is stored at all time steps since the beginning of the
* time evolution. For large objects, this might result in some memory
* problem. The class \c Evolution_std, which stores only a limited
* number of time steps, is to be prefered then.
*
*/
template<typename TyT> class Evolution_full : public Evolution<TyT> {
public:
using Evolution<TyT>::size ;
using Evolution<TyT>::step ;
using Evolution<TyT>::the_time ;
using Evolution<TyT>::val ;
using Evolution<TyT>::pos_jtop ;
using Evolution<TyT>::downdate ;
using Evolution<TyT>::position ;
using Evolution<TyT>::get_time ;
using Evolution<TyT>::get_size ;
using Evolution<TyT>::j_min ;
using Evolution<TyT>::j_max ;
using Evolution<TyT>::is_known ;
// Data:
// -----
private:
/** Factor by which the size \c size of the arrays
* \c val and \c the_time are to be multiplied when
* their limits have been reached.
*/
int fact_resize ;
// Constructors - Destructor
// -------------------------
public:
/** Constructor from initial value.
*
* @param initial_value value to be stored at time step \c initial_j
* @param initial_j index \c j of first time step to be stored
* @param initial_time time t corresponding to time step \c initial_j
* @param fact_resize_i factor by which the size \c size of the arrays
* \c val and \c the_time are to be multiplied when
* their limits have been reached.
*
*/
Evolution_full(const TyT& initial_value, int initial_j = 0,
double initial_time = 0., int fact_resize_i = 2) ;
/** Constructor without any initial value.
*
* @param fact_resize_i factor by which the size \c size of the arrays
* \c val and \c the_time are to be multiplied when
* their limits have been reached.
*
*/
Evolution_full(int fact_resize_i = 2) ;
Evolution_full(const Evolution_full<TyT>& t_in) ; ///< Copy constructor
virtual ~Evolution_full() ; ///< Destructor
// Mutators
// --------
public:
/** Sets a new value at a given time step.
* If the size of the arrays of stored values
* (members \c step, \c the_time, \c val) is not
* sufficient, it is increased by multiplication by \c fact_resize.
*/
virtual void update(const TyT& new_value, int j,
double time_j) ;
/// Assignement to another \c Evolution_full
virtual void operator=(const Evolution_full<TyT>& t_in) ;
/// Assignement to a generic \c Evolution
virtual void operator=(const Evolution<TyT>& t_in) ;
// Accessors
// ---------
// Outputs
// -------
};
//---------------------------//
// Class Evolution_std //
//---------------------------//
/** Time evolution with partial storage (*** under development ***).
* \ingroup (evol)
*
* The template class \c Evolution_std has been devised to store and
* manipulate evolving quantities of any type, for instance \c TyT = \c double
* or \c TyT = \c Scalar.
* The quantity is stored only for a limited number of time steps (the
* n last ones).
* For a full storage, use instead the class \c Evolution_full.
*
*/
template<typename TyT> class Evolution_std : public Evolution<TyT> {
public:
using Evolution<TyT>::size ;
using Evolution<TyT>::step ;
using Evolution<TyT>::the_time ;
using Evolution<TyT>::val ;
using Evolution<TyT>::pos_jtop ;
using Evolution<TyT>::downdate ;
using Evolution<TyT>::position ;
using Evolution<TyT>::get_time ;
using Evolution<TyT>::get_size ;
using Evolution<TyT>::j_min ;
using Evolution<TyT>::j_max ;
using Evolution<TyT>::is_known ;
// Constructors - Destructor
// -------------------------
public:
/** Constructor from initial value.
*
* @param initial_value value to be stored at time step \c initial_j
* @param initial_j index \c j of first time step to be stored
* @param initial_time time t corresponding to time step \c initial_j
* @param nstored total number of time steps to be stored
*
*/
Evolution_std(const TyT& initial_value, int nstored,
int initial_j = 0, double initial_time = 0.) ;
/** Constructor without any initial value.
*
* @param nstored total number of time steps to be stored
*
*/
Evolution_std(int nstored) ;
Evolution_std(const Evolution_std<TyT>& t_in) ; ///< Copy constructor
virtual ~Evolution_std() ; ///< Destructor
// Mutators
// --------
/** Sets a new value at a given time step.
* If the size of the arrays of stored values
* (members \c step, \c the_time, \c val) is not
* sufficient, this method suppresses the oldest stored value.
*/
virtual void update(const TyT& new_value, int j, double time_j) ;
/// Assignement to another \c Evolution_std
virtual void operator=(const Evolution_std<TyT>& t_in) ;
/// Assignement to a generic \c Evolution
virtual void operator=(const Evolution<TyT>& t_in) ;
// Accessors
// ---------
// Outputs
// -------
};
}
#include "Template/evolution.C"
#include "Template/evolution_full.C"
#include "Template/evolution_std.C"
#endif
|