/usr/include/openturns/FieldFunction.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 | // -*- C++ -*-
/**
* @brief The class that implements dynamical functions
*
* 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 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/>.
*
*/
#ifndef OPENTURNS_FIELDFUNCTION_HXX
#define OPENTURNS_FIELDFUNCTION_HXX
#include "openturns/TypedInterfaceObject.hxx"
#include "openturns/FieldFunctionImplementation.hxx"
#include "openturns/Function.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class FieldFunction
* @brief Simulates a dynamical function
*
* The class that simulates a dynamical function, it means
* a function acting on a set of vectors indexed by the time.
* This class is just an interface to actual implementation
* objects that can be hot-replaced during computation.
* Each implementation object refers to a specific evaluation
* @see FieldFunctionImplementation
*/
class OT_API FieldFunction
: public TypedInterfaceObject<FieldFunctionImplementation>
{
CLASSNAME;
public:
/* Some typedefs for easy reading */
/** Default constructor */
explicit FieldFunction(const UnsignedInteger spatialDimension = 1);
/** Constructor from Function */
explicit FieldFunction(const Function & function,
const UnsignedInteger spatialDimension = 1);
/** Constructor from FieldFunctionImplementation */
FieldFunction(const FieldFunctionImplementation & implementation);
/** Constructor from implementation */
FieldFunction(const Implementation & p_implementation);
#ifndef SWIG
/** Constructor from implementation pointer */
FieldFunction(FieldFunctionImplementation * p_implementation);
#endif
/** Comparison operator */
Bool operator ==(const FieldFunction & other) const;
/** String converter */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
/** Operator () */
Point operator() (const Scalar timeStamp,
const Point & inP) const;
Point operator() (const Point & location,
const Point & inP) const;
Field operator() (const Field & inFld) const;
ProcessSample operator() (const ProcessSample & inPS) const;
/** Get the i-th marginal function */
FieldFunction getMarginal(const UnsignedInteger i) const;
/** Get the function corresponding to indices components */
FieldFunction getMarginal(const Indices & indices) const;
/** Accessor for mesh dimension */
UnsignedInteger getSpatialDimension() const;
/** Accessor for input point dimension */
UnsignedInteger getInputDimension() const;
/** Accessor for output point dimension */
UnsignedInteger getOutputDimension() const;
/** Accessor for the output mesh associated with the given input mesh */
Mesh getOutputMesh(const Mesh & inputMesh) const;
/** Input description Accessor, i.e. the names of the input parameters */
Description getInputDescription() const;
/** Output description Accessor, i.e. the names of the Output parameters */
Description getOutputDescription() const;
/** Number of calls to the evaluation */
UnsignedInteger getCallsNumber() const;
}; /* class FieldFunction */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_FIELDFUNCTION_HXX */
|