/usr/include/openturns/Field.hxx is in libopenturns-dev 1.3-3.
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 | // -*- C++ -*-
/**
* @file Field.hxx
* @brief The class Field implements samples indexed by time
*
* Copyright (C) 2005-2014 Airbus-EDF-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 PARTICULAR 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/>.
*
* @author schueller
* @date 2012-07-16 15:59:45 +0200 (Mon, 16 Jul 2012)
*/
#ifndef OPENTURNS_FIELD_HXX
#define OPENTURNS_FIELD_HXX
#include "TypedInterfaceObject.hxx"
#include "FieldImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class Field
*/
class Field
: public TypedInterfaceObject<FieldImplementation>
{
CLASSNAME;
public:
/**
* Default constructor
*/
Field();
/** Constructor from a Mesh and a dimension */
Field(const Mesh & mesh,
const UnsignedLong dim);
/** Constructor from a Mesh and a sample */
Field(const Mesh & mesh,
const NumericalSample & values);
/** Constructor from implementation */
Field(const FieldImplementation & implementation);
#ifndef SWIG
/** Constructor from implementation */
Field(const Implementation & implementation);
/** Individual value accessor */
NSI_point operator[](const UnsignedLong index);
NSI_const_point operator[](const UnsignedLong index) const;
NSI_point at(const UnsignedLong index);
NSI_const_point at(const UnsignedLong index) const;
NumericalScalar & operator() (const UnsignedLong i,
const UnsignedLong j);
const NumericalScalar & operator() (const UnsignedLong i,
const UnsignedLong j) const;
NumericalScalar & at(const UnsignedLong i,
const UnsignedLong j);
const NumericalScalar & at(const UnsignedLong i,
const UnsignedLong j) const;
#endif
/** Accessor to values */
NumericalPoint getValueAtIndex(const UnsignedLong index) const;
void setValueAtIndex(const UnsignedLong index,
const NumericalPoint & val);
NumericalPoint getValueAtNearestPosition(const NumericalPoint & position) const;
void setValueAtNearestPosition(const NumericalPoint & position,
const NumericalPoint & val);
/** Description accessor */
void setDescription(const Description & description);
Description getDescription() const;
/** Mesh accessor */
Mesh getMesh() const;
RegularGrid getTimeGrid() const;
/** Comparison operator */
Bool operator ==(const Field & other) const;
/* Method __len__() is for Python */
UnsignedLong __len__() const;
NumericalPoint __getitem__ (const UnsignedLong index) const;
void __setitem__ (const UnsignedLong index,
const NumericalPoint & val);
/**
* String converter
* This method shows human readable information on the
* internal state of an Field. It is used when streaming
* the Field or for user information.
*/
String __repr__() const;
String __str__(const String & offset = "") const;
/** Size accessor */
UnsignedLong getSize() const;
/** Dimension accessor */
UnsignedLong getMeshDimension() const;
UnsignedLong getDimension() const;
/** Return the values stored in the field as a sample */
NumericalSample getSample() const;
NumericalSample getValues() const;
/** Compute the spatial mean of the field */
NumericalPoint getSpatialMean() const;
/** Compute the temporal mean of the field */
NumericalPoint getTemporalMean() const;
/** Draw a marginal of the field */
Graph drawMarginal(const UnsignedLong index = 0,
const Bool interpolate = true) const;
/** VTK export */
void exportToVTKFile(const String & fileName) const;
}; /* class Field */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_FIELD_HXX */
|