File: itkFEMElementStd.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (169 lines) | stat: -rw-r--r-- 4,777 bytes parent folder | download
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/

#ifndef itkFEMElementStd_h
#define itkFEMElementStd_h

#include "itkFEMElementBase.h"

namespace itk
{
namespace fem
{
/**
 * \class ElementStd
 * \brief Implements standard node management in the element classes.
 *
 * This is a templated helper class that automatically defines some of
 * the virtual functions in elements. It is used to avoid code duplication.
 *
 * If a derived element class has DOFs associated only with points
 * that define the geometry of the element, you can derive from this
 * class to automatically create all the functions required for proper
 * node management.
 *
 * You must specify two or three template parameters:
 *
 *   VNumberOfNodes - Number of nodes that define the element
 *                    (e.g. four for quadrilateral)
 *
 *   VNumberOfSpatialDimensions - Number of dimensions of space in which the
 *                    element is defined. This is also the size of a vector
 *                    returned by GetNodeCoordinates() member function.
 *
 *   TBaseClass - Class from which ElementStd is derived. TBaseClass must
 *                be derived from the Element base class. This enables you
 *                to use this class at any level of element definition.
 *                If not specified, it defaults to the Element class.
 * \ingroup ITKFEM
 */
template <unsigned int VNumberOfNodes, unsigned int VNumberOfSpatialDimensions, typename TBaseClass = Element>
class ITK_TEMPLATE_EXPORT ElementStd : public TBaseClass
{
public:
  /** Standard class type aliases. */
  using Self = ElementStd;
  using Superclass = TBaseClass;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(ElementStd);

  // FIXME: Add concept checking for TBaseClass, and TPointClass

  // Repeat type alias and enums from parent class

  using typename Superclass::Float;
  using typename Superclass::MatrixType;
  using typename Superclass::VectorType;
  using LoadType = typename Superclass::LoadType;
  using typename Superclass::LoadPointer;
  using typename Superclass::NodeIDType;
  using typename Superclass::DegreeOfFreedomIDType;
  using typename Superclass::Node;
  enum
  {
    InvalidDegreeOfFreedomID = Superclass::InvalidDegreeOfFreedomID
  };

  /** Number of nodes that define the element. */
  enum
  {
    NumberOfNodes = VNumberOfNodes
  };

  /** Number of dimensions of space in which element can exist. */
  enum
  {
    NumberOfSpatialDimensions = VNumberOfSpatialDimensions
  };

  /** Default constructor. Just clears the ivars. */
  ElementStd();

  /** Methods that define the geometry of an element. */
  unsigned int
  GetNumberOfNodes() const override
  {
    return NumberOfNodes;
  }

  /** Get/Set the Nodes that define the element. */
  NodeIDType
  GetNode(unsigned int n) const override
  {
    if (n >= NumberOfNodes)
    {
      return nullptr;
    }
    return this->m_node[n];
  }

  void
  SetNode(unsigned int n, NodeIDType node) override
  {
    this->SetNodeInternal(n, node);
  }
  void
  SetNode(unsigned int n, typename Superclass::Node::Pointer node) override
  {
    this->SetNodeInternal(n, node);
  }

  /** Get the nodal coordinates. */
  const VectorType &
  GetNodeCoordinates(unsigned int n) const override
  {
    return m_node[n]->GetCoordinates();
  }

  /** Get the number of spatial dimensions. */
  unsigned int
  GetNumberOfSpatialDimensions() const override
  {
    return NumberOfSpatialDimensions;
  }


protected:
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual void
  SetNodeInternal(unsigned int n, const Node * node)
  {
    if (n >= NumberOfNodes)
    {
      return;
    }
    this->m_node[n] = node;
  }

  // Array of pointers to point objects that define the element
  const Node * m_node[NumberOfNodes]{};
};

} // end namespace fem
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFEMElementStd.hxx"
#endif

#endif // itkFEMElementStd_h