File: FunctionExpression.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 (135 lines) | stat: -rw-r--r-- 3,166 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
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
//  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: FunctionExpression.hpp,v 1.20 2007/04/01 23:46:41 delpinux Exp $

#ifndef FUNCTION_EXPRESSION_HPP
#define FUNCTION_EXPRESSION_HPP

#include <Expression.hpp>
#include <ReferenceCounting.hpp>

#include <iostream>

class ScalarFunctionBase;
/**
 * @file   FunctionExpression.hpp
 * @author Stephane Del Pino
 * @date   Tue Jul  4 01:05:53 2006
 * 
 * @brief  Function expression base class
 * 
 */
class FunctionExpression
  : public Expression
{
public:
  /// functions types ids
  enum FunctionType {
    constant,
    linearBase,
    normalComponent,
    fem,
    spectral,
    derivative,
    meshReferences,
    composed,
    variable,
    cfunction,
    binaryOperation,
    unaryMinus,
    convection,

    objectCharacteristic,
    meshCharacteristic,
    domainCharacteristic,

    read,
    functionValue,
    not_,
    integrate
  };
private:
  const FunctionType __type;	/**< Type of function */

  bool __unknown;		/**< is true if the function is unknown */

protected:
  ConstReferenceCounting<ScalarFunctionBase> __scalarFunction; /**< The function associated to the expression */

  /** 
   * Specialization of the put function
   * 
   * @param os the stream
   * 
   * @return the stream @a os
   */
  virtual std::ostream& put(std::ostream& os) const;

public:
  /** 
   * Returns @b true if the functions has a boundary
   * 
   * @return false as a default value
   */
  virtual bool hasBoundaryExpression() const;

  /** 
   * Read only access to the type of the function
   * 
   * @return __type
   */
  const FunctionExpression::FunctionType& type() const;

  /** 
   * Access to the scalar function
   * 
   * @return __scalarFunction
   */
  ConstReferenceCounting<ScalarFunctionBase> function() const;

  /** 
   * Access the value of the function expression
   * 
   * @return a FunctionExpressionValue
   */
  ReferenceCounting<FunctionExpression> value();

  /** 
   * Copy constructor
   * 
   * @param e the original function expression
   * 
   */
  FunctionExpression(const FunctionExpression& e);

  /** 
   * Builds a function expression of type @a type
   * 
   * @param type the type of the function expression
   * 
   */
  FunctionExpression(const FunctionExpression::FunctionType& type);

  /** 
   * Destructor
   * 
   */
  virtual ~FunctionExpression();
};

#endif // FUNCTION_EXPRESSION_HPP