File: FunctionExpressionDerivative.hpp

package info (click to toggle)
freefem3d 1.0pre10-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 24,816 kB
  • ctags: 8,361
  • sloc: cpp: 57,201; sh: 8,788; yacc: 2,975; makefile: 1,148; ansic: 508; perl: 110
file content (109 lines) | stat: -rw-r--r-- 2,908 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
101
102
103
104
105
106
107
108
109
//  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: FunctionExpressionDerivative.hpp,v 1.2 2006/07/23 22:14:19 delpinux Exp $

#ifndef FUNCTION_EXPRESSION_DERIVATIVE_HPP
#define FUNCTION_EXPRESSION_DERIVATIVE_HPP

#include <FunctionExpression.hpp>
#include <ErrorHandler.hpp>

/**
 * @file   FunctionExpressionDerivative.hpp
 * @author Stephane Del Pino
 * @date   Tue Jul  4 01:43:55 2006
 * 
 * @brief Computes the derivative of a function expression
 * 
 */
class FunctionExpressionDerivative
  : public FunctionExpression
{
public:
  enum Direction {
    x,
    y,
    z,
    undefined
  };

private:
  FunctionExpressionDerivative::Direction __direction; /**< direction of derivation */

  ReferenceCounting<FunctionExpression> __derivedFunction; /**< function to derive */

  /** 
   * returns @b true if the function to derive has a boundary
   * 
   * @return true if the function to derive has a boundary
   */
  bool hasBoundaryExpression() const
  {
    return __derivedFunction->hasBoundaryExpression();
  }

  /** 
   * converts the string direction name to a the type Direction
   * 
   * @param name name of the direction
   * 
   * @return associated enumerate value
   */
  static FunctionExpressionDerivative::Direction
  getDirection(const std::string& name)
  {
    if (name == "dx") return x;
    if (name == "dy") return y;
    if (name == "dz") return z;
    throw ErrorHandler(__FILE__,__LINE__,
		       "unknown derivation direction",
		       ErrorHandler::unexpected);
    return undefined;
  }

public:
  /** 
   * Executes the expression
   * 
   */
  void execute();

  /** 
   * Constructor
   * 
   * @param directionName derivation direction
   * @param function function to derive
   */
  FunctionExpressionDerivative(const std::string& directionName,
			       ReferenceCounting<FunctionExpression> function);

  /** 
   * Copy constructor
   * 
   * @param f the derivative function expression
   */
  FunctionExpressionDerivative(const FunctionExpressionDerivative& f);

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

#endif // FUNCTION_EXPRESSION_DERIVATIVE_HPP