From 441b60c70dcdc8d63cd6341be328a7f07953e9b0 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Thu, 6 Jul 2023 23:11:36 +0100
Subject: [PATCH] functionEntries::calcEntry: Extended the functionality of
 multi-statement/multi-line #calc

If the code string is delimited by '#{...#}' multiple lines and multiple code
statements can be used to generate the entry using 'os << ...;'.  This is
equivalent to #codeStream but with a more compact syntax, e.g.

maxAngle        30;
nAngles         7;
Us              #calc
    const vector U($<vector>testCalc2!U);
    const int nAngles = $nAngles;
    const scalar angleStep = ($<scalar>maxAngle)/(nAngles - 1);
    List<vector> Us(nAngles);
    for(int i=0; i<nAngles; i++)
    {
        const scalar angle = degToRad(i*angleStep);
        Us[i] = transform(Ry(angle), U);
    }
    os << Us;

Note the 'os << Us;' statement which writes the data to the dictionary entry in
the same manner as #codeStream, this provides flexibility on how the data is
created and written.
---
 .../functionEntries/calcEntry/calcEntry.C     | 33 +++++++++++++----
 .../functionEntries/calcEntry/calcEntry.H     | 36 ++++++++++++-------
 test/dictionary/simpleBlockMeshDict           |  3 +-
 test/dictionary/testCalc                      | 29 ++++++++++-----
 4 files changed, 73 insertions(+), 28 deletions(-)

diff --git a/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.C b/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.C
index 24829271e0..656a74c53c 100644
--- a/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.C
+++ b/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.C
@@ -65,7 +65,7 @@ Foam::string Foam::functionEntries::calcEntry::calc
     Istream& is
 )
 {
-    Info<< "Using #calcEntry at line " << is.lineNumber()
+    Info<< "Expanding #calc at line " << is.lineNumber()
         << " in file " <<  dict.name() << endl;
 
     dynamicCode::checkSecurity
@@ -74,16 +74,37 @@ Foam::string Foam::functionEntries::calcEntry::calc
         dict
     );
 
-    // Read string delimited by either '"..."' or '#{...#}'
-    verbatimString s(is);
-
     // Construct codeDict for codeStream
     // with dict as parent dictionary for string expansion
     // and variable substitution
     dictionary codeDict(dict, dictionary());
 
-    calcIncludeEntry::codeInclude(codeDict);
-    codeDict.add("code", "os << (" + s + ");");
+    // Read the code expression string delimited by either '"..."' or '#{...#}'
+    token t(is);
+
+    if (t.isVerbatimString())
+    {
+        const verbatimString& s = t.verbatimStringToken();
+
+        calcIncludeEntry::codeInclude(codeDict);
+        codeDict.add("code", s);
+    }
+    else if (t.isString())
+    {
+        const string& s = t.stringToken();
+
+        calcIncludeEntry::codeInclude(codeDict);
+        codeDict.add("code", "os << (" + s + ");");
+    }
+    else
+    {
+        FatalIOErrorInFunction(is)
+            << "Wrong string type for #calc" << nl
+            << "    Expected either a string delimited by '\"...\"' "
+               "or a verbatim string delimited by '#{...#}' " << nl
+            << "    found token " << t
+            << exit(FatalIOError);
+    }
 
     codeStream::streamingFunctionType function = codeStream::getFunction
     (
diff --git a/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H b/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H
index 70db464a59..4019191f83 100644
--- a/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H
+++ b/src/OpenFOAM/db/dictionary/functionEntries/calcEntry/calcEntry.H
@@ -51,18 +51,9 @@ Usage
     c #calc "($a)/$b";
     \endverbatim
 
-    The code string can be delimited either by '"..."' in which newlines must be
-    escaped or '#{...#}' which directly supports multi-line strings and is more
-    convenient when evaluating string expressions by avoiding the need to
-    escape the quotes, e.g.
-
-    \verbatim
-    c #calc #{ $a*sqrt($b) #};
-    \endverbatim
-
     \verbatim
     s "field";
-    fieldName #calc #{ $<string>s + "Name" #};
+    fieldName #calc "$<string>s + \"Name\" ";
     \endverbatim
 
     Additional include files for the #calc code compilation can be specified
@@ -77,12 +68,31 @@ Usage
     dragDir         #calc "transform(Ry($angle), vector(1, 0, 0))";
     \endverbatim
 
-    Note:
-        Internally this is just a wrapper around codeStream functionality - the
-        #calc string is used to construct a dictionary for codeStream.
+    If the code string is delimited by '#{...#}' multiple lines and multiple
+    code statements can be used to generate the entry  using 'os << ...;'.
+    This is equivalent to #codeStream but with a more compact syntax.
+    \verbatim
+    #calcInclude    "transform.H"
+    maxAngle        30;
+    nAngles         7;
+    Us              #calc
+    #{
+        const vector U($<vector>testCalc2!U);
+        const int nAngles = $nAngles;
+        const scalar angleStep = ($<scalar>maxAngle)/(nAngles - 1);
+        List<vector> Us(nAngles);
+        for(int i=0; i<nAngles; i++)
+        {
+            const scalar angle = degToRad(i*angleStep);
+            Us[i] = transform(Ry(angle), U);
+        }
+        os << Us;
+    #};
+    \endverbatim
 
 See also
     Foam::functionEntries::calcIncludeEntry
+    Foam::functionEntries::codeStream
 
 SourceFiles
     calcEntry.C
diff --git a/test/dictionary/simpleBlockMeshDict b/test/dictionary/simpleBlockMeshDict
index fce3171b48..c246cdebf8 100644
--- a/test/dictionary/simpleBlockMeshDict
+++ b/test/dictionary/simpleBlockMeshDict
@@ -18,7 +18,8 @@ max         (2.5 1.2 3.0);      // Maximum coordinates of the block
 nCellsByL   33.3333;            // Number of cells per unit length
 
 // Calculate the number of cells in each block direction
-nCells      #calc #{ Vector<label>($nCellsByL*($<vector>max - $<vector>min) + vector::one/2) #};
+nCells      #calc
+    "Vector<label>($nCellsByL*($<vector>max - $<vector>min) + vector::one/2)";
 
 // Generate the vertices using a boundBox
 #calcInclude "boundBox.H"
diff --git a/test/dictionary/testCalc b/test/dictionary/testCalc
index 31e4e3d462..3709da18f0 100644
--- a/test/dictionary/testCalc
+++ b/test/dictionary/testCalc
@@ -29,15 +29,8 @@ c   #calc "$a / $b";
 
 c   #calc "($a)/$b";
 
-// The code string can be delimited either by '"..."' in which newlines must be
-// escaped or '#{...#}' which directly supports multi-line strings and is more
-// convenient when evaluating string expressions by avoiding the need to
-// escape the quotes, e.g.
-
-c   #calc #{ $a*sqrt($b) #};
-
 s   "field";
-fieldName #calc #{ $<string>s + "Name" #};
+fieldName #calc "$<string>s + \"Name\" ";
 
 // Additional include files for the #calc code compilation can be specified
 // using the #calcInclude entry, e.g. if functions from transform.H are used
@@ -54,4 +47,24 @@ dragDir         #calc "transform(Ry($angle), vector(1, 0, 0))";
 magU            #calc "mag($<vector>testCalc2!U)";
 k               #calc "1.5*magSqr(0.05*$<vector>{${FOAM_CASE}/testCalc2!U})";
 
+// If the code string is delimited by '#{...#}' multiple lines and multiple
+// code statements can be used to generate the entry  using 'os << ...;'.
+// This is equivalent to #codeStream but with a more compact syntax.
+#calcInclude    "transform.H"
+maxAngle        30;
+nAngles         7;
+Us              #calc
+#{
+    const vector U($<vector>testCalc2!U);
+    const int nAngles = $nAngles;
+    const scalar angleStep = ($<scalar>maxAngle)/(nAngles - 1);
+    List<vector> Us(nAngles);
+    for(int i=0; i<nAngles; i++)
+    {
+        const scalar angle = degToRad(i*angleStep);
+        Us[i] = transform(Ry(angle), U);
+    }
+    os << Us;
+#};
+
 // ************************************************************************* //