/usr/include/dune/pdelab/common/functionwrappers.hh is in libdune-pdelab-dev 2.0.0-1.
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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_PDELAB_FUNCTIONWRAPPERS_HH
#define DUNE_PDELAB_FUNCTIONWRAPPERS_HH
#include <vector>
#include <dune/typetree/nodetags.hh>
#include "function.hh"
namespace Dune {
namespace PDELab {
//! \ingroup PDELab_FunctionAdapters
//! \{
//////////////////////////////////////////////////////////////////////
//
// PointwiseGridFunctionAdapter
//
//! A function wrapper which can map a set of gridfunctions through an
//! PointwiseAdapterEngine
/**
* \tparam Engine The type of the engine
* \tparam FN The types of the functions. Currently, N up to 9 is
* supported.
*/
template<typename Engine, typename F0,
typename F1 = TypeTree::EmptyNode,
typename F2 = TypeTree::EmptyNode,
typename F3 = TypeTree::EmptyNode,
typename F4 = TypeTree::EmptyNode,
typename F5 = TypeTree::EmptyNode,
typename F6 = TypeTree::EmptyNode,
typename F7 = TypeTree::EmptyNode,
typename F8 = TypeTree::EmptyNode,
typename F9 = TypeTree::EmptyNode>
class PointwiseGridFunctionAdapter :
public GridFunctionInterface<
typename F0::Traits,
PointwiseGridFunctionAdapter<
Engine,
F0, F1, F2, F3, F4, F5, F6, F7, F8, F9> >
{
public:
typedef typename F0::Traits Traits;
private:
const Engine& engine;
const F0& f0;
const F1& f1;
const F2& f2;
const F3& f3;
const F4& f4;
const F5& f5;
const F6& f6;
const F7& f7;
const F8& f8;
const F9& f9;
//! hold the number of non-EmptyNode functions
unsigned size;
//! increment a sum (but only if type(*f) != EmptyNode via overloading)
/**
* \tparam F The type of *f
*
* \param sum The variable to increment
* \param f Dummy parameter, only its type is of importance to select
* the correct method from the overloaded set
*/
template<typename F>
static void inc(unsigned &sum, const F* f)
{ ++sum; }
//! increment a sum (well, don't, since type(*f) == EmptyNode)
/**
* \param sum The variable to increment (well, not to imcrement)
* \param f Dummy parameter, only its type is of importance to select
* the correct method from the overloaded set
*/
static void inc(unsigned &sum, const TypeTree::EmptyNode* f)
{ }
//! count the number of non-EmptyNode functions
/**
* uses the inc()-methods
*/
static unsigned count() {
unsigned sum = 0;
inc(sum, (F0*)0);
inc(sum, (F1*)0);
inc(sum, (F2*)0);
inc(sum, (F3*)0);
inc(sum, (F4*)0);
inc(sum, (F5*)0);
inc(sum, (F6*)0);
inc(sum, (F7*)0);
inc(sum, (F8*)0);
inc(sum, (F9*)0);
return sum;
}
//! \brief evaluate a function (but only if type(f) != EmptyNode via
//! overloading)
/**
* \tparam F The type of f
*
* \param f The function to evaluate
* \param index The index to write to in the std::vector y. This index
* is incremented after use.
* \param e The element at which to evaluate
* \param x The local coordinates inside x where to evaluate.
* \param y Where to write the result of the evaluation.
*/
template<typename F>
static void evaluate(const F &f, unsigned &index,
const typename Traits::ElementType& e,
const typename Traits::DomainType& x,
std::vector<typename Traits::RangeType>& y) {
f.evaluate(e, x, y[index]);
++index;
}
//! evaluate a function (well, don't, since type(f) == EmptyNode)
/**
* \param f Dummy argument, only its type EmptyNode is of importance
* to select the correct method from the overload set.
* \param index The index to write to in the std::vector y. Since this
* dummy methid doesn't actually write anythin to y, the
* index is not incremented afterwards.
* \param e The element at which to evaluate
* \param x The local coordinates inside x where to evaluate.
* \param y Where to write the result of the evaluation. Well, its
* not actually used in this dummy method
*/
static void evaluate(const TypeTree::EmptyNode &f, unsigned &index,
const typename Traits::ElementType& e,
const typename Traits::DomainType& x,
std::vector<typename Traits::RangeType>& y)
{ }
public:
#ifdef DOXYGEN
//! construct a PointwiseGridFunctionAdapter
/**
* \param engine_ A reference to the engine. The referenced engine
* object must live at least as long as this adapter
* object is used for evaluation.
* \param f0_ Reference to the first function.
* \param ... References to the other functions. These referenced function
* objects must live at least as long as this adapter
* object is used for evaluation. Currently, up to 9 functions
* are supported.
*/
PointwiseGridFunctionAdapter(const Engine& engine_, const F0& f0_, ...)
{}
#else
PointwiseGridFunctionAdapter(const Engine& engine_, const F0& f0_,
const F1& f1_ = TypeTree::EmptyNode(),
const F2& f2_ = TypeTree::EmptyNode(),
const F3& f3_ = TypeTree::EmptyNode(),
const F4& f4_ = TypeTree::EmptyNode(),
const F5& f5_ = TypeTree::EmptyNode(),
const F6& f6_ = TypeTree::EmptyNode(),
const F7& f7_ = TypeTree::EmptyNode(),
const F8& f8_ = TypeTree::EmptyNode(),
const F9& f9_ = TypeTree::EmptyNode())
: engine(engine_), f0(f0_)
, f1(f1_), f2(f2_), f3(f3_)
, f4(f4_), f5(f5_), f6(f6_)
, f7(f7_), f8(f8_), f9(f9_)
, size(count())
{}
#endif // DOXYGEN
inline void evaluate (const typename Traits::ElementType& e,
const typename Traits::DomainType& x,
typename Traits::RangeType& y) const
{
std::vector<typename Traits::RangeType> in(size);
unsigned index = 0;
evaluate(f0, index, e, x, in);
evaluate(f1, index, e, x, in);
evaluate(f2, index, e, x, in);
evaluate(f3, index, e, x, in);
evaluate(f4, index, e, x, in);
evaluate(f5, index, e, x, in);
evaluate(f6, index, e, x, in);
evaluate(f7, index, e, x, in);
evaluate(f8, index, e, x, in);
evaluate(f9, index, e, x, in);
engine.evaluate(y, in);
}
inline const typename Traits::GridViewType& getGridView () const
{
return f0.getGridView();
}
};
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0>
PointwiseGridFunctionAdapter<Engine, F0>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0)
{
return PointwiseGridFunctionAdapter
<Engine,F0>
(engine,f0);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1>
PointwiseGridFunctionAdapter<Engine, F0, F1>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1>
(engine,f0,f1);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2>
(engine,f0,f1,f2);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3>
(engine,f0,f1,f2,f3);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3, typename F4>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3, F4>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3,
const F4& f4)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3,F4>
(engine,f0,f1,f2,f3,f4);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3, typename F4, typename F5>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3, F4, F5>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3,
const F4& f4, const F5& f5)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3,F4,F5>
(engine,f0,f1,f2,f3,f4,f5);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3, typename F4, typename F5, typename F6>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3, F4, F5, F6>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3,
const F4& f4, const F5& f5, const F6& f6)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3,F4,F5,F6>
(engine,f0,f1,f2,f3,f4,f5,f6);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3, typename F4, typename F5, typename F6, typename F7>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3, F4, F5, F6, F7>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3,
const F4& f4, const F5& f5, const F6& f6,
const F7& f7)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3,F4,F5,F6,F7>
(engine,f0,f1,f2,f3,f4,f5,f6,f7);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3, typename F4, typename F5, typename F6, typename F7,
typename F8>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3, F4, F5, F6, F7, F8>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3,
const F4& f4, const F5& f5, const F6& f6,
const F7& f7, const F8& f8)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3,F4,F5,F6,F7,F8>
(engine,f0,f1,f2,f3,f4,f5,f6,f7,f8);
}
//! syntactic sugar for easy creation of PointwiseGridFunctionAdapter
//! objects
template<typename Engine, typename F0, typename F1, typename F2,
typename F3, typename F4, typename F5, typename F6, typename F7,
typename F8, typename F9>
PointwiseGridFunctionAdapter<Engine, F0, F1, F2, F3, F4, F5, F6, F7, F8,
F9>
makePointwiseGridFunctionAdapter(const Engine& engine, const F0& f0,
const F1& f1, const F2& f2, const F3& f3,
const F4& f4, const F5& f5, const F6& f6,
const F7& f7, const F8& f8, const F9& f9)
{
return PointwiseGridFunctionAdapter
<Engine,F0,F1,F2,F3,F4,F5,F6,F7,F8,F9>
(engine,f0,f1,f2,f3,f4,f5,f6,f7,f8,f9);
}
//////////////////////////////////////////////////////////////////////
//
// AdapterEngines
//
//! Interface of a pointwise adapter engine
class PointwiseAdapterEngine
{
public:
//! calculate the adapted value from a set of input values
/**
* \tparam Domain type of input value
* \tparam Range type of output value
*
* \param out Where to store the output value
* \param in The list of input values
*/
template<typename Domain, typename Range>
void evaluate(Range& out,
const std::vector<Domain>& in) const;
};
//! Scale the output value
/**
* \tparam S type of the scaling factor
*
* \implements PointwiseAdapterEngine
*/
template<typename S>
class PointwiseScaleAdapterEngine
{
S scale;
public:
//! create a PointwiseScaleAdapterEngine
/**
* \param scale_ The scaling factor
*/
PointwiseScaleAdapterEngine(const S scale_)
: scale(scale_)
{}
//! \copydoc PointwiseAdapterEngine::evaluate
template<typename Domain, typename Range>
void evaluate(Range& out,
const std::vector<Domain>& in) const {
assert(in.size() == 1);
out = in[0];
out *= scale;
}
};
//! syntactic sugar to create a PointwiseScaleAdapterEngine
/**
* \relates PointwiseScaleAdapterEngine
*/
template<typename S>
PointwiseScaleAdapterEngine<S>
makePointwiseScaleAdapterEngine(const S scale) {
return PointwiseScaleAdapterEngine<S>(scale);
}
//! Sum all terms
/**
* \tparam S type of the scaling factor
*
* \implements PointwiseAdapterEngine
*/
class PointwiseSumAdapterEngine
{
public:
//! \copydoc PointwiseAdapterEngine::evaluate
template<typename Domain, typename Range>
void evaluate(Range& out,
const std::vector<Domain>& in) const {
out = 0;
for(unsigned i = 0; i < in.size(); ++i)
out += in[i];
}
};
//! \} Function
} // namespace PDELab
} // namespace Dune
#endif // DUNE_PDELAB_FUNCTIONWRAPPERS_HH
|