force.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2020 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::regionModels::areaSurfaceFilmModels::force
28
29Description
30 Base class for film (stress-based) force models
31
32SourceFiles
33 force.C
34 forceNew.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef force_H
39#define force_H
40
41#include "filmSubModelBase.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48namespace regionModels
49{
50namespace areaSurfaceFilmModels
51{
52
53/*---------------------------------------------------------------------------*\
54 Class force Declaration
55\*---------------------------------------------------------------------------*/
57class force
58:
59 public filmSubModelBase
60{
61 // Private Member Functions
62
63 //- No copy construct
64 force(const force&) = delete;
65
66 //- No copy assignment
67 void operator=(const force&) = delete;
68
69
70public:
71
72 //- Runtime type information
73 TypeName("force");
74
75
76 // Declare runtime constructor selection table
79 (
80 autoPtr,
81 force,
83 (
85 const dictionary& dict
86 ),
87 (film, dict)
88 );
89
90 // Constructors
91
92 //- Construct null
94
95 //- Construct from type name, dictionary and surface film model
96 force
97 (
98 const word& modelType,
100 const dictionary& dict
101 );
102
103
104 // Selectors
105
106 //- Return a reference to the selected force model
107 static autoPtr<force> New
108 (
110 const dictionary& dict,
111 const word& modelType
112 );
113
114
115 //- Destructor
116 virtual ~force();
117
118
119 // Member Functions
120
121 // Evolution
122
123 //- Correct
125};
126
127
128// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129
130} // End namespace areaSurfaceFilmModels
131} // End namespace regionModels
132} // End namespace Foam
133
134// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135
136#endif
137
138// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const liquidFilmBase & film() const
Return const access to the film surface film model.
Base class for film (stress-based) force models.
Definition: force.H:59
TypeName("force")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, force, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict))
static autoPtr< force > New(liquidFilmBase &film, const dictionary &dict, const word &modelType)
Return a reference to the selected force model.
Definition: forceNew.C:42
virtual tmp< faVectorMatrix > correct(areaVectorField &U)=0
Correct.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:113
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:125
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
U
Definition: pEqn.H:72
thermo correct()
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73