force.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) 2011-2020 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::regionModels::surfaceFilmModels::force
26 
27 Description
28  Base class for film (stress-based) force models
29 
30 SourceFiles
31  force.C
32  forceNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef force_H
37 #define force_H
38 
39 #include "filmSubModelBase.H"
40 #include "runTimeSelectionTables.H"
41 #include "fvMatrices.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace regionModels
48 {
49 namespace surfaceFilmModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class force Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class force
57 :
58  public filmSubModelBase
59 {
60 public:
61 
62  //- Runtime type information
63  TypeName("force");
64 
65 
66  // Declare runtime constructor selection table
67 
69  (
70  autoPtr,
71  force,
72  dictionary,
73  (
75  const dictionary& dict
76  ),
77  (film, dict)
78  );
79 
80  // Constructors
81 
82  //- Construct null
84 
85  //- Construct from type name, dictionary and surface film model
86  force
87  (
88  const word& modelType,
90  const dictionary& dict
91  );
92 
93  //- Disallow default bitwise copy construction
94  force(const force&) = delete;
95 
96 
97  // Selectors
98 
99  //- Return a reference to the selected force model
100  static autoPtr<force> New
101  (
103  const dictionary& dict,
104  const word& modelType
105  );
106 
107 
108  //- Destructor
109  virtual ~force();
110 
111 
112  // Member Functions
113 
114  // Evolution
115 
116  //- Correct
118 
119 
120  // Member Operators
121 
122  //- Disallow default bitwise assignment
123  void operator=(const force&) = delete;
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace surfaceFilmModels
130 } // End namespace regionModels
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
Base class for surface film sub-models.
Base class for film (stress-based) force models.
Definition: force.H:55
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
declareRunTimeSelectionTable(autoPtr, force, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
A class for handling words, derived from string.
Definition: word.H:59
TypeName("force")
Runtime type information.
void operator=(const force &)=delete
Disallow default bitwise assignment.
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
static autoPtr< force > New(surfaceFilmRegionModel &film, const dictionary &dict, const word &modelType)
Return a reference to the selected force model.
Definition: forceNew.C:40
U
Definition: pEqn.H:72
virtual tmp< fvVectorMatrix > correct(volVectorField &U)=0
Correct.
force(surfaceFilmRegionModel &film)
Construct null.
Definition: force.C:44
A special matrix type and solver, designed for finite volume solutions of scalar equations.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.