none_solidBodyMotionFunction.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2026 OpenFOAM Foundation
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::solidBodyMotionFunctions::none
26 
27 Description
28  Dummy motion function for stationary regions
29 
30 SourceFiles
31  none_solidBodyMotionFunction.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef none_solidBodyMotionFunction_H
36 #define none_solidBodyMotionFunction_H
37 
39 #include "primitiveFields.H"
40 #include "point.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace solidBodyMotionFunctions
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class none Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class none
54 :
56 {
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("none");
62 
63 
64  // Constructors
65 
66  //- Construct from components
67  none
68  (
69  const word& name,
70  const Time& runTime
71  );
72 
73  //- Construct from components
74  none
75  (
76  const word& name,
77  const dictionary& SBMFCoeffs,
78  const Time& runTime
79  );
80 
81  //- Disallow default bitwise copy construction
82  none(const none&) = delete;
83 
84 
85  //- Construct and return a clone
87  {
89  (
90  new none(name_, time_)
91  );
92  }
93 
94 
95  //- Destructor
96  virtual ~none();
97 
98 
99  // Member Functions
100 
101  //- Return the static solid-body motion transformation septernion
102  virtual septernion transformation() const;
103 
104  //- Dummy read
105  virtual bool read(const dictionary&);
106 
107  //- Dummy write
108  virtual void writeData(Ostream&) const;
109 
110 
111  // Member Operators
112 
113  //- Disallow default bitwise assignment
114  void operator=(const none&) = delete;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace solidBodyMotionFunctions
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Septernion class used to perform translations and rotations in 3D space.
Definition: septernion.H:66
Base class for defining solid-body motions.
Dummy motion function for stationary regions.
TypeName("none")
Runtime type information.
virtual autoPtr< solidBodyMotionFunction > clone() const
Construct and return a clone.
virtual septernion transformation() const
Return the static solid-body motion transformation septernion.
virtual void writeData(Ostream &) const
Dummy write.
void operator=(const none &)=delete
Disallow default bitwise assignment.
none(const word &name, const Time &runTime)
Construct from components.
virtual bool read(const dictionary &)
Dummy read.
A class for handling words, derived from string.
Definition: word.H:63
Namespace for OpenFOAM.
Specialisations of Field<T> for scalar, vector and tensor.