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
|
/*=========================================================================
*
* 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 itkFEMLoadBase_h
#define itkFEMLoadBase_h
#include "itkFEMElementBase.h"
#include "itkFEMSolution.h"
#include "itkFEMPArray.h"
#include "ITKFEMExport.h"
namespace itk
{
namespace fem
{
/**
* \class Load
* \brief General abstract load base class.
*
* All other load classes that can be used in a FEM system are defined by deriving this one.
* The load class defines an external load that acts on the system. For each specific subtype
* of load, a separate load abstract class should be derived. For example we have LoadElement,
* which defines the base for all loads that act on a specific element in a system.
* \ingroup ITKFEM
*/
class ITKFEM_EXPORT Load : public FEMLightObject
{
public:
/** Standard class type aliases. */
using Self = Load;
using Superclass = FEMLightObject;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(Load);
/** Array class that holds special pointers to the load objects */
using ArrayType = FEMPArray<Self>;
/**
* Sets the pointer to solution vector. This function is automatically
* called by the Solver class on every load object.
*
* Some types of external Loads may need access to previous values of
* solution vector. If a derived class needs that, it should implement
* this function, and store the passed pointer accordingly. If the result
* vector is not required, the function should be left unimplemented,
* so that only the dummy implementation in base class is called.
*
* param ptr Pointer to the object of Solution class.
*/
virtual void
SetSolution(Solution::ConstPointer itkNotUsed(ptr))
{}
virtual Solution::ConstPointer
GetSolution()
{
return nullptr;
}
/**
* Get the element containing the degree of freedom
* on which the force is being applied.
*/
const Element *
GetElement() const
{
return m_Element;
}
/**
* Get the element containing the degree of freedom
* on which the force is being applied.
*/
void
SetElement(const Element * el)
{
this->m_Element = el;
}
protected:
void
PrintSelf(std::ostream & os, Indent indent) const override;
/**
* Pointer to an element in a system that contains the DOF
* on which the external force is applied.
*/
Element::ConstPointer m_Element{};
};
} // end namespace fem
} // end namespace itk
#endif // itkFEMLoadBase_h
|
