/usr/include/libmesh/function_base.h is in libmesh-dev 0.7.1-2ubuntu1.
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 | // $Id: function_base.h 3874 2010-07-02 21:57:26Z roystgnr $
// The libMesh Finite Element Library.
// Copyright (C) 2002-2008 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
// 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 2.1 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
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#ifndef __function_base_h__
#define __function_base_h__
// C++ includes
// Local Includes
#include "libmesh_common.h"
namespace libMesh
{
// Forward Declarations
template <typename T> class DenseVector;
class FunctionBase;
class Point;
/**
* This is the base class for functor-like classes. These
* entities are functions (in the mathematical sense) of time
* and space, \f$ f(\mathbf{x},t) = \mbox{\texttt{v}} \f$,
* where \p v may be either a \p Number or a \p DenseVector<Number>.
* Children of this base class implement different styles of
* data retrieval for these functions. Use the constructors
* of the derived classes for creating new objects. The
* required input of each derived class thwarts the effective
* use of the commonly used \p build() member. But afterwards
* the virtual members allow the convenient and libMesh-common
* usage through a \p FunctionBase*.
*
* @author Daniel Dreyer, 2003
*/
// ------------------------------------------------------------
// FunctionBase class definition
class FunctionBase
{
protected:
/**
* Constructor. Optionally takes a master.
*/
FunctionBase (const FunctionBase* master = NULL);
public:
/**
* Destructor.
*/
virtual ~FunctionBase ();
/**
* The actual initialization process.
*/
virtual void init () = 0;
/**
* Clears the function.
*/
virtual void clear () = 0;
// ------------------------------------------------------
// misc
/**
* @returns the scalar value at coordinate
* \p p and time \p time, which defaults to zero.
* Purely virtual, so you have to overload it.
* Note that this cannot be a const method, check \p MeshFunction.
*/
virtual Number operator() (const Point& p,
const Real time = 0.) = 0;
/**
* Return function for vectors.
* Returns in \p output the values of the data at the
* coordinate \p p.
*/
void operator() (const Point& p,
DenseVector<Number>& output);
/**
* Return function for vectors.
* Returns in \p output the values of the data at the
* coordinate \p p and for time \p time.
* Purely virtual, so you have to overload it.
* Note that this cannot be a const method, check \p MeshFunction.
*/
virtual void operator() (const Point& p,
const Real time,
DenseVector<Number>& output) = 0;
/**
* @returns \p true when this object is properly initialized
* and ready for use, \p false otherwise.
*/
bool initialized () const;
protected:
/**
* Const pointer to our master, initialized to \p NULL.
* There may be cases where multiple functions are required,
* but to save memory, one master handles some centralized
* data.
*/
const FunctionBase* _master;
/**
* When \p init() was called so that everything is ready
* for calls to \p operator() (...), then this \p bool is true.
*/
bool _initialized;
};
// ------------------------------------------------------------
// FunctionBase inline methods
inline
bool FunctionBase::initialized() const
{
return (this->_initialized);
}
inline
void FunctionBase::operator() (const Point& p,
DenseVector<Number>& output)
{
// Call the time-dependent function with t=0.
this->operator()(p, 0., output);
}
} // namespace libMesh
#endif
|