File: ScalarFunctionDerivative.hpp

package info (click to toggle)
freefem3d 1.0pre10-3.4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 25,016 kB
  • ctags: 8,675
  • sloc: cpp: 57,204; sh: 8,788; yacc: 2,975; makefile: 1,149; ansic: 508; perl: 110
file content (100 lines) | stat: -rw-r--r-- 2,543 bytes parent folder | download | duplicates (5)
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
//  This file is part of ff3d - http://www.freefem.org/ff3d
//  Copyright (C) 2001, 2002, 2003 Stphane Del Pino

//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2, or (at your option)
//  any later version.

//  This program 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 General Public License for more details.

//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  

//  $Id: ScalarFunctionDerivative.hpp,v 1.4 2007/05/01 13:15:32 delpinux Exp $

#ifndef SCALAR_FUNCTION_DERIVATIVE_HPP
#define SCALAR_FUNCTION_DERIVATIVE_HPP

#include <ScalarFunctionBase.hpp>
#include <ReferenceCounting.hpp>

/**
 * @file   ScalarFunctionDerivative.hpp
 * @author Stephane Del Pino
 * @date   Thu Jul 20 00:57:12 2006
 * 
 * @brief  scalar function derivative
 * 
 * @bug only implemented for discret functions
 */
class ScalarFunctionDerivative
  : public ScalarFunctionBase
{
public:
  enum Direction {
    x,
    y,
    z
  };

private:
  const Direction __direction;	/**< direction of derivation */
  ConstReferenceCounting<ScalarFunctionBase>
  __functionToDerive;	/**< function to derive */

  /** 
   * Writes the function to a stream
   * 
   * @param os output stream
   * 
   * @return os
   */
  std::ostream& __put(std::ostream& os) const;

public:
  /** 
   * Evaluates the derivative at point @f$ X @f$
   * 
   * @return @f$ \partial_i f(X) @f$
   */
  real_t operator()(const TinyVector<3,real_t>& X) const;

  /** 
   * Checks if the function can be simplified
   * 
   * @return false
   */
  bool canBeSimplified() const
  {
    return false;
  }

  /** 
   * Constructor
   * 
   * @param direction direction of derivation
   * @param functionToDerive the function to derive
   */
  ScalarFunctionDerivative(const ScalarFunctionDerivative::Direction& direction,
			   ConstReferenceCounting<ScalarFunctionBase> functionToDerive);

  /** 
   * Copy constructor
   * 
   * @param f the function to copy
   */
  ScalarFunctionDerivative(const ScalarFunctionDerivative& f);

  /** 
   * Destructor
   * 
   */
  ~ScalarFunctionDerivative();
};

#endif // SCALAR_FUNCTION_DERIVATIVE_HPP