Loading...
Searching...
No Matches
solverFieldSelection.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) 2017-2023 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
26\*---------------------------------------------------------------------------*/
27
29#include "fvMesh.H"
30#include "volMesh.H"
31#include "fvPatchField.H"
32
33// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
34
36(
37 const objectRegistry& obr,
38 const bool includeComponents
39)
40:
41 fieldSelection(obr, includeComponents)
42{
43 if (!isA<fvMesh>(obr))
44 {
46 << "Registry must be of type " << fvMesh::typeName
48 }
49}
50
51
52// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
53
55{
56 List<fieldInfo> oldSet(std::move(selection_));
57
58 DynamicList<fieldInfo> newSelection(oldSet.size());
59
60 const fvMesh& mesh = static_cast<const fvMesh&>(obr_);
61
62 const dictionary& solverDict = mesh.data().solverPerformanceDict();
63
64 const wordList solvedFieldNames(solverDict.sortedToc());
65
66 for (const fieldInfo& fi : *this)
67 {
68 for (const word& solvedField : solvedFieldNames)
69 {
70 if (fi.name().match(solvedField))
71 {
72 fi.found(true);
73 newSelection.emplace_back(wordRe(solvedField), fi.component());
74 }
75 }
76 }
77
78 selection_.transfer(newSelection);
79
81 {
83 << "Valid solver fields are: " << solvedFieldNames;
84 }
85
86 return selection_ != oldSet;
87}
88
89
90// ************************************************************************* //
A 1D vector of objects of type <T> that resizes itself as necessary to accept the new objects.
Definition DynamicList.H:68
T & emplace_back(Args &&... args)
Construct an element at the end of the list, return reference to the new list element.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition List.H:72
void size(const label n)
Older name for setAddressableSize.
Definition UList.H:118
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
wordList sortedToc() const
Return the sorted table of contents.
Definition dictionary.C:601
Helper class to store a wordRe and label used by Foam::functionObjects::fieldSelection.
Definition fieldInfo.H:52
bool found() const noexcept
Return the found state.
Definition fieldInfo.H:127
label component() const noexcept
Return the component.
Definition fieldInfo.H:122
const wordRe & name() const noexcept
Return the selector pattern for the field name(s).
Definition fieldInfo.H:117
virtual bool checkSelection()
Check that all requested fielda have been found.
const objectRegistry & obr_
Reference to the database.
List< fieldInfo > selection_
Current field selection.
virtual bool updateSelection()
Update the selection using current contents of obr_.
solverFieldSelection(const solverFieldSelection &)=delete
No copy construct.
Mesh data needed to do the Finite Volume discretisation.
Definition fvMesh.H:85
Registry of regIOobjects.
A wordRe is a Foam::word, but can contain a regular expression for matching words or strings.
Definition wordRe.H:81
bool match(const std::string &text, bool literal=false) const
Smart match as regular expression or as a string.
Definition wordReI.H:193
A class for handling words, derived from Foam::string.
Definition word.H:66
dynamicFvMesh & mesh
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition error.H:600
#define WarningInFunction
Report a warning using Foam::Warning.
List< word > wordList
List of word.
Definition fileName.H:60
const Type * isA(const U &obj)
Attempt dynamic_cast to Type.
Definition typeInfo.H:87
errorManip< error > abort(error &err)
Definition errorManip.H:139
error FatalError
Error stream (stdout output on all processes), with additional 'FOAM FATAL ERROR' header text and sta...