forceList.C
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 -------------------------------------------------------------------------------
10 License
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 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "forceList.H"
29 
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34 namespace regionModels
35 {
36 namespace areaSurfaceFilmModels
37 {
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
42 :
43  PtrList<force>()
44 {}
45 
46 
48 (
49  liquidFilmBase& film,
50  const dictionary& dict
51 )
52 :
54 {
55  const wordList models(dict.lookup("forces"));
56 
57  Info<< " Selecting film force models" << endl;
58  if (models.size() > 0)
59  {
60  this->setSize(models.size());
61 
62  forAll(models, i)
63  {
64  set(i, force::New(film, dict, models[i]));
65  }
66  }
67  else
68  {
69  Info<< " none" << endl;
70  }
71 }
72 
73 
74 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
75 
77 {}
78 
79 
80 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
81 
83 {
84  tmp<faVectorMatrix> tResult
85  (
87  );
88  faVectorMatrix& result = tResult.ref();
89 
90  forAll(*this, i)
91  {
92  result += this->operator[](i).correct(U);
93  }
94 
95  return tResult;
96 }
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace areaSurfaceFilmModels
101 } // End namespace regionModels
102 } // End namespace Foam
103 
104 // ************************************************************************* //
Foam::regionModels::areaSurfaceFilmModels::forceList::forceList
forceList(liquidFilmBase &film)
Construct null.
Definition: forceList.C:41
Foam::regionModels::areaSurfaceFilmModels::liquidFilmBase
Definition: liquidFilmBase.H:60
setSize
points setSize(newPointi)
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::faMatrix
A special matrix type and solver, designed for finite area solutions of scalar equations....
Definition: faMatricesFwd.H:43
forceList.H
Foam::faVectorMatrix
faMatrix< vector > faVectorMatrix
Definition: faMatrices.H:53
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::dimDensity
const dimensionSet dimDensity
Foam::regionModels::areaSurfaceFilmModels::force::New
static autoPtr< force > New(liquidFilmBase &film, const dictionary &dict, const word &modelType)
Return a reference to the selected force model.
Definition: forceNew.C:42
Foam::regionModels::areaSurfaceFilmModels::force
Base class for film (stress-based) force models.
Definition: force.H:56
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::dimForce
const dimensionSet dimForce
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::regionModels::areaSurfaceFilmModels::forceList::correct
tmp< faVectorMatrix > correct(areaVectorField &U)
Return (net) force system.
Definition: forceList.C:82
Foam::tmp::ref
T & ref() const
Definition: tmpI.H:227
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:59
Foam::dictionary::lookup
ITstream & lookup(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionary.C:386
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
U
U
Definition: pEqn.H:72
Foam::regionModels::areaSurfaceFilmModels::forceList::~forceList
virtual ~forceList()
Destructor.
Definition: forceList.C:76
Foam::List< word >
Foam::GeometricField< vector, faPatchField, areaMesh >