File: ScalarFunctionLinearBasis.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 (141 lines) | stat: -rw-r--r-- 3,005 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
136
137
138
139
140
141
//  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: ScalarFunctionLinearBasis.hpp,v 1.3 2006/10/28 12:26:54 delpinux Exp $

#ifndef SCALAR_FUNCTION_LINEAR_BASIS_HPP
#define SCALAR_FUNCTION_LINEAR_BASIS_HPP

#include <ScalarFunctionBase.hpp>

/**
 * @file   ScalarFunctionLinearBasis.hpp
 * @author Stephane Del Pino
 * @date   Thu Jul 20 01:42:18 2006
 * 
 * @brief  linear function canonical basis
 * 
 */
class ScalarFunctionLinearBasis
  : public ScalarFunctionBase
{
public:
  enum BasisType {
    x,
    y,
    z
  };

private:
  const BasisType __basisType;	/**< type of basis function */

  /** 
   * Write the function to a stream
   * 
   * @param os output stream
   * 
   * @return os
   */
  std::ostream& __put(std::ostream& os) const
  {
    switch (__basisType) {
    case ScalarFunctionLinearBasis::x: {
      os << 'x';
      break;
    }
    case ScalarFunctionLinearBasis::y: {
      os << 'y';
      break;
    }
    case ScalarFunctionLinearBasis::z: {
      os << 'z';
      break;
    }
    }
    return os;
  }

public:
  /** 
   * Evaluates the function at point @f$ X @f$
   * 
   * @param X evaluation point
   * 
   * @return @f$ X_i @f$
   */
  real_t operator()(const TinyVector<3, real_t>& X) const
  {
    switch (__basisType) {
    case ScalarFunctionLinearBasis::x: {
      return X[0];
    }
    case ScalarFunctionLinearBasis::y: {
      return X[1];
    }
    case ScalarFunctionLinearBasis::z: {
      return X[2];
    }
    }
    // never reached
    return 0;
  }

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

  /** 
   * Constructor
   * 
   * @param basisType basis function type
   */
  ScalarFunctionLinearBasis(const BasisType& basisType)
    : ScalarFunctionBase(ScalarFunctionBase::linearBasis),
      __basisType(basisType)
  {
    ;
  }

  /** 
   * Copy constructor
   * 
   * @param f original function
   */
  ScalarFunctionLinearBasis(const ScalarFunctionLinearBasis& f)
    : ScalarFunctionBase(f),
      __basisType(f.__basisType)
  {
    ;
  }

  /** 
   * Destructor
   * 
   */
  ~ScalarFunctionLinearBasis()
  {
    ;
  }
};

#endif // SCALAR_FUNCTION_LINEAR_BASIS_HPP