/usr/include/openturns/FieldImplementation.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 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 | // -*- C++ -*-
/**
* @brief The class FieldImplementation implements values indexed by
* the vertices of a Mesh
*
* 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_FIELDIMPLEMENTATION_HXX
#define OPENTURNS_FIELDIMPLEMENTATION_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/Sample.hxx"
#include "openturns/Mesh.hxx"
#include "openturns/RegularGrid.hxx"
#include "openturns/TBB.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class FieldImplementation
*/
class OT_API FieldImplementation
: public PersistentObject
{
CLASSNAME;
public:
/**
* Default constructor
*/
FieldImplementation();
/** Standard constructor */
FieldImplementation(const Mesh & mesh,
const UnsignedInteger dim);
/** Constructor from a Mesh and a sample */
FieldImplementation(const Mesh & mesh,
const Sample & values);
/** Accessor to values */
Point getValueAtIndex(const UnsignedInteger index) const;
void setValueAtIndex(const UnsignedInteger index,
const Point & val);
Point getValueAtNearestPosition(const Point & position) const;
void setValueAtNearestPosition(const Point & position,
const Point & val);
/** Accessor to values */
Point getValueAtNearestTime(const Scalar timestamp) const;
void setValueAtNearestTime(const Scalar timestamp,
const Point & val);
/** Virtual constructor */
virtual FieldImplementation * clone() const;
/** Description Accessor */
void setDescription(const Description & description);
Description getDescription() const;
/** Mesh accessor */
Mesh getMesh() const;
RegularGrid getTimeGrid() const;
/** Comparison operator */
Bool operator ==(const FieldImplementation & other) const;
/**
* String converter
* This method shows human readable information on the
* internal state of an FieldImplementation. It is used when streaming
* the FieldImplementation or for user information.
*/
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Size accessor */
UnsignedInteger getSize() const;
/** Dimension accessor */
UnsignedInteger getSpatialDimension() const;
UnsignedInteger getDimension() const;
/** Return the values stored in the field as a sample */
Sample getSample() const;
Sample getValues() const;
void setValues(const Sample & values);
/** Get the i-th marginal sample */
FieldImplementation getMarginal(const UnsignedInteger index) const;
/** Get the marginal sample corresponding to indices dimensions */
FieldImplementation getMarginal(const Indices & indices) const;
#ifndef SWIG
/** Individual value accessor */
NSI_point operator[](const UnsignedInteger index);
NSI_const_point operator[](const UnsignedInteger index) const;
NSI_point at(const UnsignedInteger index);
NSI_const_point at(const UnsignedInteger index) const;
Scalar & operator() (const UnsignedInteger i,
const UnsignedInteger j);
const Scalar & operator() (const UnsignedInteger i,
const UnsignedInteger j) const;
Scalar & at(const UnsignedInteger i,
const UnsignedInteger j);
const Scalar & at(const UnsignedInteger i,
const UnsignedInteger j) const;
#endif
/** Return the field as a sample, ie its values and positions */
Sample asSample() const;
/** Return the field as a defomed mesh, ie its values are added to the components of the vertices if the dimensions match */
Mesh asDeformedMesh() const;
/** Compute the spatial mean of the field */
Point getSpatialMean() const;
/** Compute the temporal mean of the field, ie its spatial mean when the mesh
is regular and of dimension 1 */
Point getTemporalMean() const;
/** Draw a marginal of the timeSerie */
Graph drawMarginal(const UnsignedInteger index = 0,
const Bool interpolate = true) const;
Graph draw() 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);
/** VTK export */
void exportToVTKFile(const String & fileName) const;
protected:
/** Compute the spatial mean of the field */
void computeSpatialMean() const;
/** The mesh associated to the field */
Mesh mesh_;
/** The values associated to the field */
Sample values_;
/** The description of all components */
Description description_;
/** The spatial mean */
mutable Point spatialMean_;
/** Flag to tell if the spatial mean has already been computed */
mutable Bool isAlreadyComputedSpatialMean_;
private:
friend struct FieldSpatialMeanFunctor;
}; /* class FieldImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_FIELDIMPLEMENTATION_HXX */
|