manual_oneDimensionalDiscretisation.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) 2025 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 
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace oneDimensionalDiscretisations
34 {
37  (
39  manual,
41  );
42 }
43 }
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 (
50  const word& name,
51  const dimensionSet& dims,
52  const label n,
53  const dictionary& dict
54 )
55 :
57  (
58  name,
59  dims,
60  scalarField(dict.lookup<scalarList>("values", dims))
61  )
62 {
63  if (coordinates().size() != n)
64  {
66  << n << " values are required, but " << coordinates().size()
67  << " were specified" << exit(FatalIOError);
68  }
69 
70  for (label i = 0; i < coordinates().size() - 1; ++ i)
71  {
72  if (coordinates()[i] >= coordinates()[i + 1])
73  {
75  << "The specified values are not in order"
76  << exit(FatalIOError);
77  }
78  }
79 }
80 
81 
82 // ************************************************************************* //
label n
Macros for easy insertion into run-time selection tables.
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Dimension set for the base types.
Definition: dimensionSet.H:125
Base class for ways in which to generate coordinates in one-dimensional space. Used to space the repr...
const scalarField & coordinates() const
Return the coordinates.
Manual coordinate spacing. The user explicitly provides a list of coordinates which must increase mon...
manual(const word &name, const dimensionSet &dims, const label n, const dictionary &dict)
Construct from a dictionary.
A class for handling words, derived from string.
Definition: word.H:63
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
addToRunTimeSelectionTable(oneDimensionalDiscretisation, exponential, dictionary)
const unitSet & lookup(const word &unitName)
Lookup and return the named unit from the table.
Definition: units.C:346
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
IOerror FatalIOError
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
dictionary dict