/usr/include/openturns/RegularGrid.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief The class RegularGrid implements an equaly spaced set of real values
*
* Copyright 2005-2017 Airbus-EDF-IMACS-Phimeca
*
* 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 3 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 PARTCULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef OPENTURNS_REGULARGRID_HXX
#define OPENTURNS_REGULARGRID_HXX
#include "openturns/Mesh.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class RegularGrid
*
* The RegularGrid class defines some regular time slice defined by three values:
* - either a start time, an interval (aka timeStep) and a number of steps
* - or a start time, a number of steps and an end time
*
* Note: the end time conforms to the STL standard of "one past the end", so
* the following formula defines the end time:
* end time = start time + ( timeStep * steps )
*/
class OT_API RegularGrid
: public Mesh
{
CLASSNAME;
public:
/** Default constructor */
RegularGrid();
/** Parameters constructor */
RegularGrid(const Scalar start,
const Scalar step,
const UnsignedInteger n);
/** Parameters constructor */
RegularGrid(const Mesh & mesh);
/** Virtual constructor method */
virtual RegularGrid * clone() const;
/** Comparison operator */
Bool operator == (const RegularGrid & rhs) const;
/** Comparison operator */
Bool operator != (const RegularGrid & rhs) const;
/** Start accessor */
Scalar getStart() const;
/** This method computes the timestamp of the very next step past the time series (STL convention) */
Scalar getEnd() const;
/** Step accessor */
Scalar getStep() const;
/** TimeStamp number accessor */
UnsignedInteger getN() const;
/** Get the value at index i */
Scalar getValue(const UnsignedInteger i) const;
/** Get all the values as a sample */
Point getValues() const;
/** Check if the given grid follows the current grid */
Bool follows(const RegularGrid & starter) const;
/** Tells if it is regular */
Bool isRegular() const;
/** Get the index of the nearest vertex */
UnsignedInteger getNearestVertexIndex(const Point & point) const;
/**
* String converter
*/
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Method save() stores the object through the StorageManager */
virtual void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
virtual void load(Advocate & adv);
private:
/** The start of the regular grid */
Scalar start_;
/** The step of the regular grid */
Scalar step_;
/** The number of stamps of the underlying regular grid */
UnsignedInteger n_;
}; // end class RegularGrid
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_REGULARGRID_HXX */
|