surfaceToVolVelocity.C
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) 2022 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 \*---------------------------------------------------------------------------*/
25 
26 #include "surfaceToVolVelocity.H"
27 
28 // * * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * //
29 
31 (
32  const surfaceVectorField& Uf
33 )
34 {
35  if (!isFaceVelocity(Uf))
36  {
37  return volVectorField::null();
38  }
39 
40  const word UfName(Uf.member());
41 
42  if (UfName.back() != 'f')
43  {
44  return volVectorField::null();
45  }
46 
47  const word Uname =
48  IOobject::groupName(UfName(UfName.size() - 1), Uf.group());
49 
50  if (!Uf.mesh().foundObject<volVectorField>(Uname))
51  {
52  return volVectorField::null();
53  }
54 
55  return Uf.mesh().lookupObject<volVectorField>(Uname);
56 }
57 
58 
59 // ************************************************************************* //
static word group(const word &name)
Return group (extension part of name)
Definition: IOobject.C:134
Return the vol-field velocity corresponding to a given surface-field velocity.
const volVectorField & surfaceToVolVelocity(const surfaceVectorField &Uf)
Get the cell velocity field corresponding to a given face velocity, or a.
static word member(const word &name)
Return member (name without the extension)
Definition: IOobject.C:149
bool isFaceVelocity(const DimensionedField< Type, surfaceMesh > &df)
Check if surfaceField is a face velocity or momentum.
Definition: surfaceFields.H:74
A class for handling words, derived from string.
Definition: word.H:59
const Mesh & mesh() const
Return mesh.