File: ScalarFunctionNormal.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 (124 lines) | stat: -rw-r--r-- 2,739 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
//  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: ScalarFunctionNormal.hpp,v 1.3 2006/10/28 12:26:54 delpinux Exp $

#ifndef SCALAR_FUNCTION_NORMAL_HPP
#define SCALAR_FUNCTION_NORMAL_HPP

#include <ScalarFunctionBase.hpp>

/**
 * @file   ScalarFunctionNormal.hpp
 * @author Stephane Del Pino
 * @date   Wed Jun 14 01:00:35 2006
 * 
 * @brief This class is a simple normal component evaluating function
 * 
 * This works using the @see NormalManager class
 * 
 */
class ScalarFunctionNormal
  : public ScalarFunctionBase
{
public:
  enum ComponentType
  {
    undefined,
    x,
    y,
    z
  };

private:
  ComponentType __componentType; /**< The desired component */

  /** 
   * Writes the function to a given stream
   * 
   * @param os output stream
   * 
   * @return os
   */
  std::ostream& __put(std::ostream& os) const
  {
    switch(__componentType) {
    case ScalarFunctionNormal::undefined: {
      os << "[undefined normal]";
      break;
    }
    case ScalarFunctionNormal::x: {
      os << "nx";
      break;
    }
    case ScalarFunctionNormal::y: {
      os << "ny";
      break;
    }
    case ScalarFunctionNormal::z: {
      os << "nz";
      break;
    }
    }
    return os;
  }

public:
  /** 
   * Evaluates the normal a position @a X
   * 
   * @param X position
   * 
   * @note a boundary @b must be defined to evaluate the normal
   * 
   * @return @f$ n_i(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 normalType the desired component
   */
  ScalarFunctionNormal(const ComponentType& normalType)
    : ScalarFunctionBase(ScalarFunctionBase::normal),
      __componentType(normalType)
  {
    ;
  }

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

#endif // SCALAR_FUNCTION_NORMAL_HPP