Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
postProcessing
functionObjects
forces
pointPatchFields
derived
sixDoFRigidBodyMotion
sixDoFRigidBodyMotionConstraint
fixedPlane
fixedPlane.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
License
9
This file is part of OpenFOAM.
10
11
OpenFOAM is free software: you can redistribute it and/or modify it
12
under the terms of the GNU General Public License as published by
13
the Free Software Foundation, either version 3 of the License, or
14
(at your option) any later version.
15
16
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19
for more details.
20
21
You should have received a copy of the GNU General Public License
22
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23
24
Class
25
Foam::sixDoFRigidBodyMotionConstraints::fixedPlane
26
27
Description
28
sixDoFRigidBodyMotionConstraint. Reference point may only move
29
along a plane.
30
31
SourceFiles
32
fixedPlane.C
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef fixedPlane_H
37
#define fixedPlane_H
38
39
#include <
forces/sixDoFRigidBodyMotionConstraint.H
>
40
#include <
OpenFOAM/plane.H
>
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
namespace
sixDoFRigidBodyMotionConstraints
48
{
49
50
/*---------------------------------------------------------------------------*\
51
Class fixedPlane Declaration
52
\*---------------------------------------------------------------------------*/
53
54
class
fixedPlane
55
:
56
public
sixDoFRigidBodyMotionConstraint
57
{
58
// Private data
59
60
//- Plane which the transformed reference point is constrained
61
// to move along
62
plane
fixedPlane_;
63
64
65
public
:
66
67
//- Runtime type information
68
TypeName
(
"fixedPlane"
);
69
70
71
// Constructors
72
73
//- Construct from components
74
fixedPlane
75
(
76
const
dictionary
& sDoFRBMCDict
77
);
78
79
//- Construct and return a clone
80
virtual
autoPtr<sixDoFRigidBodyMotionConstraint>
clone
()
const
81
{
82
return
autoPtr<sixDoFRigidBodyMotionConstraint>
83
(
84
new
fixedPlane
(*
this
)
85
);
86
}
87
88
89
// Destructor
90
91
virtual
~fixedPlane
();
92
93
94
// Member Functions
95
96
//- Calculate the constraint position, force and moment.
97
// Global reference frame vectors. Returns boolean stating
98
// whether the constraint been converged to tolerance.
99
virtual
bool
constrain
100
(
101
const
sixDoFRigidBodyMotion
& motion,
102
const
vector
& existingConstraintForce,
103
const
vector
& existingConstraintMoment,
104
scalar deltaT,
105
vector
& constraintPosition,
106
vector
& constraintForceIncrement,
107
vector
& constraintMomentIncrement
108
)
const
;
109
110
//- Update properties from given dictionary
111
virtual
bool
read
(
const
dictionary
& sDoFRBMCCoeff);
112
113
//- Write
114
virtual
void
write
(
Ostream
&)
const
;
115
};
116
117
118
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119
120
}
// End namespace solidBodyMotionFunctions
121
}
// End namespace Foam
122
123
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124
125
#endif
126
127
// ************************ vim: set sw=4 sts=4 et: ************************ //