DimensionedScalarField.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) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2019-2023 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "DimensionedScalarField.H"
30 
31 #define TEMPLATE template<class GeoMesh>
32 #include "DimensionedFieldFunctionsM.C"
33 
34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 
39 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
40 
41 template<class GeoMesh>
42 tmp<DimensionedField<scalar, GeoMesh>> stabilise
43 (
44  const DimensionedField<scalar, GeoMesh>& dsf,
45  const dimensioned<scalar>& ds
46 )
47 {
48  auto tres =
49  DimensionedField<scalar, GeoMesh>::New
50  (
51  "stabilise(" + dsf.name() + ',' + ds.name() + ')',
52  dsf.mesh(),
53  dsf.dimensions() + ds.dimensions()
54  );
55 
56  stabilise(tres.ref().field(), dsf.field(), ds.value());
57 
58  return tres;
59 }
60 
61 
62 template<class GeoMesh>
63 tmp<DimensionedField<scalar, GeoMesh>> stabilise
64 (
65  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf,
66  const dimensioned<scalar>& ds
67 )
68 {
69  const DimensionedField<scalar, GeoMesh>& dsf = tdsf();
70 
71  tmp<DimensionedField<scalar, GeoMesh>> tres = New
72  (
73  tdsf,
74  "stabilise(" + dsf.name() + ',' + ds.name() + ')',
75  dsf.dimensions() + ds.dimensions()
76  );
77 
78  stabilise(tres.ref().field(), dsf.field(), ds.value());
79 
80  tdsf.clear();
81 
82  return tres;
83 }
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, +, '+', add)
89 BINARY_TYPE_OPERATOR(scalar, scalar, scalar, -, '-', subtract)
90 
91 BINARY_OPERATOR(scalar, scalar, scalar, *, '*', multiply)
92 BINARY_OPERATOR(scalar, scalar, scalar, /, '|', divide)
93 
94 BINARY_TYPE_OPERATOR_SF(scalar, scalar, scalar, /, '|', divide)
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 template<class GeoMesh>
99 tmp<DimensionedField<scalar, GeoMesh>> pow
100 (
101  const DimensionedField<scalar, GeoMesh>& f1,
102  const DimensionedField<scalar, GeoMesh>& f2
103 )
104 {
105  if
106  (
107  dimensionSet::checking()
108  && (!f1.dimensions().dimensionless() || !f2.dimensions().dimensionless())
109  )
110  {
111  FatalErrorInFunction
112  << "pow() expects dimensionless parameters, but found" << nl;
113 
114  if (!f1.dimensions().dimensionless())
115  {
116  FatalError
117  << " Base field dimensions: " << f1.dimensions() << nl;
118  }
119  if (!f2.dimensions().dimensionless())
120  {
121  FatalError
122  << " Exponent field dimensions: " << f2.dimensions() << nl;
123  }
124  FatalError << exit(FatalError);
125  }
126 
127  auto tresult =
128  DimensionedField<scalar, GeoMesh>::New
129  (
130  "pow(" + f1.name() + ',' + f2.name() + ')',
131  f1.mesh(),
132  dimless
133  );
134 
135  pow(tresult.ref().field(), f1.field(), f2.field());
136 
137  return tresult;
138 }
139 
140 
141 template<class GeoMesh>
142 tmp<DimensionedField<scalar, GeoMesh>> pow
143 (
144  const tmp<DimensionedField<scalar, GeoMesh>>& tf1,
145  const DimensionedField<scalar, GeoMesh>& f2
146 )
147 {
148  const auto& f1 = tf1();
149 
150  if
151  (
152  dimensionSet::checking()
153  && (!f1.dimensions().dimensionless() || !f2.dimensions().dimensionless())
154  )
155  {
156  FatalErrorInFunction
157  << "pow() expects dimensionless parameters, but found" << nl;
158 
159  if (!f1.dimensions().dimensionless())
160  {
161  FatalError
162  << " Base field dimensions: " << f1.dimensions() << nl;
163  }
164  if (!f2.dimensions().dimensionless())
165  {
166  FatalError
167  << " Exponent field dimensions: " << f2.dimensions() << nl;
168  }
169  FatalError << exit(FatalError);
170  }
171 
172  tmp<DimensionedField<scalar, GeoMesh>> tresult = New
173  (
174  tf1,
175  "pow(" + f1.name() + ',' + f2.name() + ')',
176  dimless
177  );
178 
179  pow(tresult.ref().field(), f1.field(), f2.field());
180 
181  tf1.clear();
182 
183  return tresult;
184 }
185 
186 
187 template<class GeoMesh>
188 tmp<DimensionedField<scalar, GeoMesh>> pow
189 (
190  const DimensionedField<scalar, GeoMesh>& f1,
191  const tmp<DimensionedField<scalar, GeoMesh>>& tf2
192 )
193 {
194  const auto& f2 = tf2();
195 
196  if
197  (
198  dimensionSet::checking()
199  && (!f1.dimensions().dimensionless() || !f2.dimensions().dimensionless())
200  )
201  {
202  FatalErrorInFunction
203  << "pow() expects dimensionless parameters, but found" << nl;
204 
205  if (!f1.dimensions().dimensionless())
206  {
207  FatalError
208  << " Base field dimensions: " << f1.dimensions() << nl;
209  }
210  if (!f2.dimensions().dimensionless())
211  {
212  FatalError
213  << " Exponent field dimensions: " << f2.dimensions() << nl;
214  }
215  FatalError << exit(FatalError);
216  }
217 
218  tmp<DimensionedField<scalar, GeoMesh>> tresult = New
219  (
220  tf2,
221  "pow(" + f1.name() + ',' + f2.name() + ')',
222  dimless
223  );
224 
225  pow(tresult.ref().field(), f1.field(), f2.field());
226 
227  tf2.clear();
228 
229  return tresult;
230 }
231 
232 
233 template<class GeoMesh>
234 tmp<DimensionedField<scalar, GeoMesh>> pow
235 (
236  const tmp<DimensionedField<scalar, GeoMesh>>& tf1,
237  const tmp<DimensionedField<scalar, GeoMesh>>& tf2
238 )
239 {
240  const auto& f1 = tf1();
241  const auto& f2 = tf2();
242 
243  if
244  (
245  dimensionSet::checking()
246  && (!f1.dimensions().dimensionless() || !f2.dimensions().dimensionless())
247  )
248  {
249  FatalErrorInFunction
250  << "pow() expects dimensionless parameters, but found" << nl;
251 
252  if (!f1.dimensions().dimensionless())
253  {
254  FatalError
255  << " Base field dimensions: " << f1.dimensions() << nl;
256  }
257  if (!f2.dimensions().dimensionless())
258  {
259  FatalError
260  << " Exponent field dimensions: " << f2.dimensions() << nl;
261  }
262  FatalError << exit(FatalError);
263  }
264 
265  auto tresult =
266  reuseTmpTmpDimensionedField<scalar, scalar, scalar, scalar, GeoMesh>::
267  New
268  (
269  tf1,
270  tf2,
271  "pow(" + f1.name() + ',' + f2.name() + ')',
272  dimless
273  );
274 
275  pow(tresult.ref().field(), f1.field(), f2.field());
276 
277  tf1.clear();
278  tf2.clear();
279 
280  return tresult;
281 }
282 
283 
284 template<class GeoMesh>
285 tmp<DimensionedField<scalar, GeoMesh>> pow
286 (
287  const DimensionedField<scalar, GeoMesh>& f1,
288  const dimensionedScalar& ds
289 )
290 {
291  if
292  (
293  dimensionSet::checking()
294  && (!ds.dimensions().dimensionless())
295  )
296  {
297  FatalErrorInFunction
298  << "pow() expects dimensionless parameters, but found" << nl
299  << " Exponent dimensions: " << ds.dimensions() << nl
300  << exit(FatalError);
301  }
302 
303  auto tresult =
304  DimensionedField<scalar, GeoMesh>::New
305  (
306  "pow(" + f1.name() + ',' + ds.name() + ')',
307  f1.mesh(),
308  pow(f1.dimensions(), ds)
309  );
310 
311  pow(tresult.ref().field(), f1.field(), ds.value());
312 
313  return tresult;
314 }
315 
316 
317 template<class GeoMesh>
318 tmp<DimensionedField<scalar, GeoMesh>> pow
319 (
320  const tmp<DimensionedField<scalar, GeoMesh>>& tf1,
321  const dimensionedScalar& ds
322 )
323 {
324  const auto& f1 = tf1();
325 
326  if
327  (
328  dimensionSet::checking()
329  && (!ds.dimensions().dimensionless())
330  )
331  {
332  FatalErrorInFunction
333  << "pow() expects dimensionless parameters, but found" << nl
334  << " Exponent dimensions: " << ds.dimensions() << nl
335  << exit(FatalError);
336  }
337 
338  tmp<DimensionedField<scalar, GeoMesh>> tresult = New
339  (
340  tf1,
341  "pow(" + f1.name() + ',' + ds.name() + ')',
342  pow(f1.dimensions(), ds)
343  );
344 
345  pow(tresult.ref().field(), f1.field(), ds.value());
346 
347  tf1.clear();
348 
349  return tresult;
350 }
351 
352 
353 template<class GeoMesh>
354 tmp<DimensionedField<scalar, GeoMesh>> pow
355 (
356  const DimensionedField<scalar, GeoMesh>& dsf,
357  const scalar& s
358 )
359 {
360  return pow(dsf, dimensionedScalar(s));
361 }
362 
363 
364 template<class GeoMesh>
365 tmp<DimensionedField<scalar, GeoMesh>> pow
366 (
367  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf,
368  const scalar& s
369 )
370 {
371  return pow(tdsf, dimensionedScalar(s));
372 }
373 
374 
375 template<class GeoMesh>
376 tmp<DimensionedField<scalar, GeoMesh>> pow
377 (
378  const dimensionedScalar& ds,
379  const DimensionedField<scalar, GeoMesh>& f2
380 )
381 {
382  if
383  (
384  dimensionSet::checking()
385  && (!ds.dimensions().dimensionless() || !f2.dimensions().dimensionless())
386  )
387  {
388  FatalErrorInFunction
389  << "pow() expects dimensionless parameters, but found" << nl;
390 
391  if (!ds.dimensions().dimensionless())
392  {
393  FatalError
394  << " Base scalar dimensions: " << ds.dimensions() << nl;
395  }
396  if (!f2.dimensions().dimensionless())
397  {
398  FatalError
399  << " Exponent field dimensions: " << f2.dimensions() << nl;
400  }
401  FatalError << exit(FatalError);
402  }
403 
404  auto tresult =
405  DimensionedField<scalar, GeoMesh>::New
406  (
407  "pow(" + ds.name() + ',' + f2.name() + ')',
408  f2.mesh(),
409  dimless
410  );
411 
412  pow(tresult.ref().field(), ds.value(), f2.field());
413 
414  return tresult;
415 }
416 
417 
418 template<class GeoMesh>
419 tmp<DimensionedField<scalar, GeoMesh>> pow
420 (
421  const dimensionedScalar& ds,
422  const tmp<DimensionedField<scalar, GeoMesh>>& tf2
423 )
424 {
425  const auto& f2 = tf2();
426 
427  if
428  (
429  dimensionSet::checking()
430  && (!ds.dimensions().dimensionless() || !f2.dimensions().dimensionless())
431  )
432  {
433  FatalErrorInFunction
434  << "pow() expects dimensionless parameters, but found" << nl;
435 
436  if (!ds.dimensions().dimensionless())
437  {
438  FatalError
439  << " Base scalar dimensions: " << ds.dimensions() << nl;
440  }
441  if (!f2.dimensions().dimensionless())
442  {
443  FatalError
444  << " Exponent field dimensions: " << f2.dimensions() << nl;
445  }
446 
447  FatalError << exit(FatalError);
448  }
449 
450  tmp<DimensionedField<scalar, GeoMesh>> tresult = New
451  (
452  tf2,
453  "pow(" + ds.name() + ',' + f2.name() + ')',
454  dimless
455  );
456 
457  pow(tresult.ref().field(), ds.value(), f2.field());
458 
459  tf2.clear();
460 
461  return tresult;
462 }
463 
464 template<class GeoMesh>
465 tmp<DimensionedField<scalar, GeoMesh>> pow
466 (
467  const scalar& s,
468  const DimensionedField<scalar, GeoMesh>& dsf
469 )
470 {
471  return pow(dimensionedScalar(s), dsf);
472 }
473 
474 template<class GeoMesh>
475 tmp<DimensionedField<scalar, GeoMesh>> pow
476 (
477  const scalar& s,
478  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf
479 )
480 {
481  return pow(dimensionedScalar(s), tdsf);
482 }
483 
484 
485 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
486 
487 template<class GeoMesh>
488 tmp<DimensionedField<scalar, GeoMesh>> atan2
489 (
490  const DimensionedField<scalar, GeoMesh>& dsf1,
491  const DimensionedField<scalar, GeoMesh>& dsf2
492 )
493 {
494  auto tres =
495  DimensionedField<scalar, GeoMesh>::New
496  (
497  "atan2(" + dsf1.name() + ',' + dsf2.name() + ')',
498  dsf1.mesh(),
499  atan2(dsf1.dimensions(), dsf2.dimensions())
500  );
501 
502  atan2(tres.ref().field(), dsf1.field(), dsf2.field());
503 
504  return tres;
505 }
506 
507 
508 template<class GeoMesh>
509 tmp<DimensionedField<scalar, GeoMesh>> atan2
510 (
511  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf1,
512  const DimensionedField<scalar, GeoMesh>& dsf2
513 )
514 {
515  const DimensionedField<scalar, GeoMesh>& dsf1 = tdsf1();
516 
517  tmp<DimensionedField<scalar, GeoMesh>> tres = New
518  (
519  tdsf1,
520  "atan2(" + dsf1.name() + ',' + dsf2.name() + ')',
521  atan2(dsf1.dimensions(), dsf2.dimensions())
522  );
523 
524  atan2(tres.ref().field(), dsf1.field(), dsf2.field());
525 
526  tdsf1.clear();
527 
528  return tres;
529 }
530 
531 
532 template<class GeoMesh>
533 tmp<DimensionedField<scalar, GeoMesh>> atan2
534 (
535  const DimensionedField<scalar, GeoMesh>& dsf1,
536  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf2
537 )
538 {
539  const DimensionedField<scalar, GeoMesh>& dsf2 = tdsf2();
540 
541  tmp<DimensionedField<scalar, GeoMesh>> tres = New
542  (
543  tdsf2,
544  "atan2(" + dsf1.name() + ',' + dsf2.name() + ')',
545  atan2(dsf1.dimensions(), dsf2.dimensions())
546  );
547 
548  atan2(tres.ref().field(), dsf1.field(), dsf2.field());
549 
550  tdsf2.clear();
551 
552  return tres;
553 }
554 
555 template<class GeoMesh>
556 tmp<DimensionedField<scalar, GeoMesh>> atan2
557 (
558  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf1,
559  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf2
560 )
561 {
562  const DimensionedField<scalar, GeoMesh>& dsf1 = tdsf1();
563  const DimensionedField<scalar, GeoMesh>& dsf2 = tdsf2();
564 
565  auto tres =
566  reuseTmpTmpDimensionedField<scalar, scalar, scalar, scalar, GeoMesh>::
567  New
568  (
569  tdsf1,
570  tdsf2,
571  "atan2(" + dsf1.name() + ',' + dsf2.name() + ')',
572  atan2(dsf1.dimensions(), dsf2.dimensions())
573  );
574 
575  atan2(tres.ref().field(), dsf1.field(), dsf2.field());
576 
577  tdsf1.clear();
578  tdsf2.clear();
579 
580  return tres;
581 }
582 
583 
584 template<class GeoMesh>
585 tmp<DimensionedField<scalar, GeoMesh>> atan2
586 (
587  const DimensionedField<scalar, GeoMesh>& dsf,
588  const dimensionedScalar& ds
589 )
590 {
591  auto tres =
592  DimensionedField<scalar, GeoMesh>::New
593  (
594  "atan2(" + dsf.name() + ',' + ds.name() + ')',
595  dsf.mesh(),
596  atan2(dsf.dimensions(), ds)
597  );
598 
599  atan2(tres.ref().field(), dsf.field(), ds.value());
600 
601  return tres;
602 }
603 
604 template<class GeoMesh>
605 tmp<DimensionedField<scalar, GeoMesh>> atan2
606 (
607  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf,
608  const dimensionedScalar& ds
609 )
610 {
611  const DimensionedField<scalar, GeoMesh>& dsf = tdsf();
612 
613  tmp<DimensionedField<scalar, GeoMesh>> tres = New
614  (
615  tdsf,
616  "atan2(" + dsf.name() + ',' + ds.name() + ')',
617  atan2(dsf.dimensions(), ds)
618  );
619 
620  atan2(tres.ref().field(), dsf.field(), ds.value());
621 
622  tdsf.clear();
623 
624  return tres;
625 }
626 
627 template<class GeoMesh>
628 tmp<DimensionedField<scalar, GeoMesh>> atan2
629 (
630  const DimensionedField<scalar, GeoMesh>& dsf,
631  const scalar& s
632 )
633 {
634  return atan2(dsf, dimensionedScalar(s));
635 }
636 
637 template<class GeoMesh>
638 tmp<DimensionedField<scalar, GeoMesh>> atan2
639 (
640  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf,
641  const scalar& s
642 )
643 {
644  return atan2(tdsf, dimensionedScalar(s));
645 }
646 
647 
648 template<class GeoMesh>
649 tmp<DimensionedField<scalar, GeoMesh>> atan2
650 (
651  const dimensionedScalar& ds,
652  const DimensionedField<scalar, GeoMesh>& dsf
653 )
654 {
655  auto tres =
656  DimensionedField<scalar, GeoMesh>::New
657  (
658  "atan2(" + ds.name() + ',' + dsf.name() + ')',
659  dsf.mesh(),
660  atan2(ds, dsf.dimensions())
661  );
662 
663  atan2(tres.ref().field(), ds.value(), dsf.field());
664 
665  return tres;
666 }
667 
668 
669 template<class GeoMesh>
670 tmp<DimensionedField<scalar, GeoMesh>> atan2
671 (
672  const dimensionedScalar& ds,
673  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf
674 )
675 {
676  const DimensionedField<scalar, GeoMesh>& dsf = tdsf();
677 
678  tmp<DimensionedField<scalar, GeoMesh>> tres = New
679  (
680  tdsf,
681  "atan2(" + ds.name() + ',' + dsf.name() + ')',
682  atan2(ds, dsf.dimensions())
683  );
684 
685  atan2(tres.ref().field(), ds.value(), dsf.field());
686 
687  tdsf.clear();
688 
689  return tres;
690 }
691 
692 template<class GeoMesh>
693 tmp<DimensionedField<scalar, GeoMesh>> atan2
694 (
695  const scalar& s,
696  const DimensionedField<scalar, GeoMesh>& dsf
697 )
698 {
699  return atan2(dimensionedScalar(s), dsf);
700 }
701 
702 template<class GeoMesh>
703 tmp<DimensionedField<scalar, GeoMesh>> atan2
704 (
705  const scalar& s,
706  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf
707 )
708 {
709  return atan2(dimensionedScalar(s), tdsf);
710 }
711 
712 
713 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
714 
715 UNARY_FUNCTION(scalar, scalar, pow3, pow3)
716 UNARY_FUNCTION(scalar, scalar, pow4, pow4)
717 UNARY_FUNCTION(scalar, scalar, pow5, pow5)
718 UNARY_FUNCTION(scalar, scalar, pow6, pow6)
719 UNARY_FUNCTION(scalar, scalar, pow025, pow025)
720 UNARY_FUNCTION(scalar, scalar, sqrt, sqrt)
721 UNARY_FUNCTION(scalar, scalar, cbrt, cbrt)
722 UNARY_FUNCTION(scalar, scalar, sign, sign)
723 UNARY_FUNCTION(scalar, scalar, pos, pos)
724 UNARY_FUNCTION(scalar, scalar, pos0, pos0)
725 UNARY_FUNCTION(scalar, scalar, neg, neg)
726 UNARY_FUNCTION(scalar, scalar, neg0, neg0)
727 UNARY_FUNCTION(scalar, scalar, posPart, posPart)
728 UNARY_FUNCTION(scalar, scalar, negPart, negPart)
729 
730 UNARY_FUNCTION(scalar, scalar, exp, trans)
731 UNARY_FUNCTION(scalar, scalar, log, trans)
732 UNARY_FUNCTION(scalar, scalar, log10, trans)
733 UNARY_FUNCTION(scalar, scalar, sin, trans)
734 UNARY_FUNCTION(scalar, scalar, cos, trans)
735 UNARY_FUNCTION(scalar, scalar, tan, trans)
736 UNARY_FUNCTION(scalar, scalar, asin, trans)
737 UNARY_FUNCTION(scalar, scalar, acos, trans)
738 UNARY_FUNCTION(scalar, scalar, atan, trans)
739 UNARY_FUNCTION(scalar, scalar, sinh, trans)
740 UNARY_FUNCTION(scalar, scalar, cosh, trans)
741 UNARY_FUNCTION(scalar, scalar, tanh, trans)
742 UNARY_FUNCTION(scalar, scalar, asinh, trans)
743 UNARY_FUNCTION(scalar, scalar, acosh, trans)
744 UNARY_FUNCTION(scalar, scalar, atanh, trans)
745 UNARY_FUNCTION(scalar, scalar, erf, trans)
746 UNARY_FUNCTION(scalar, scalar, erfc, trans)
747 UNARY_FUNCTION(scalar, scalar, lgamma, trans)
748 UNARY_FUNCTION(scalar, scalar, j0, trans)
749 UNARY_FUNCTION(scalar, scalar, j1, trans)
750 UNARY_FUNCTION(scalar, scalar, y0, trans)
751 UNARY_FUNCTION(scalar, scalar, y1, trans)
752 
753 
754 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
755 
756 #define BesselFunc(func) \
757  \
758 template<class GeoMesh> \
759 tmp<DimensionedField<scalar, GeoMesh>> func \
760 ( \
761  const int n, \
762  const DimensionedField<scalar, GeoMesh>& dsf \
763 ) \
764 { \
765  if (dimensionSet::checking() && !dsf.dimensions().dimensionless()) \
766  { \
767  FatalErrorInFunction \
768  << "Field is not dimensionless: " << dsf.dimensions() << nl \
769  << abort(FatalError); \
770  } \
771  \
772  auto tres = \
773  DimensionedField<scalar, GeoMesh>::New \
774  ( \
775  #func "(" + name(n) + ',' + dsf.name() + ')', \
776  dsf.mesh(), \
777  dimless \
778  ); \
779  \
780  func(tres.ref().field(), n, dsf.field()); \
781  \
782  return tres; \
783 } \
784  \
785  \
786 template<class GeoMesh> \
787 tmp<DimensionedField<scalar, GeoMesh>> func \
788 ( \
789  const int n, \
790  const tmp<DimensionedField<scalar, GeoMesh>>& tdsf \
791 ) \
792 { \
793  const auto& dsf = tdsf(); \
794  \
795  if (dimensionSet::checking() && !dsf.dimensions().dimensionless()) \
796  { \
797  FatalErrorInFunction \
798  << "Field is not dimensionless: " << dsf.dimensions() << nl \
799  << abort(FatalError); \
800  } \
801  \
802  tmp<DimensionedField<scalar, GeoMesh>> tres \
803  ( \
804  New \
805  ( \
806  tdsf, \
807  #func "(" + name(n) + ',' + dsf.name() + ')', \
808  dimless \
809  ) \
810  ); \
811  \
812  func(tres.ref().field(), n, dsf.field()); \
813  \
814  tdsf.clear(); \
815  \
816  return tres; \
817 }
818 
819 BesselFunc(jn)
820 BesselFunc(yn)
821 
822 #undef BesselFunc
823 
824 
825 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
826 
827 } // End namespace Foam
828 
829 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
830 
831 #include "undefFieldFunctionsM.H"
832 
833 // ************************************************************************* //
Foam::sign
dimensionedScalar sign(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:159
Foam::tanh
dimensionedScalar tanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:265
Foam::dimensioned::value
const Type & value() const noexcept
Return const reference to value.
Definition: dimensionedType.H:366
Foam::acos
dimensionedScalar acos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:261
BINARY_OPERATOR
#define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:416
Foam::divide
void divide(DimensionedField< Type, GeoMesh > &result, const DimensionedField< Type, GeoMesh > &f1, const DimensionedField< scalar, GeoMesh > &f2)
Foam::log
dimensionedScalar log(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:255
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
Foam::FatalError
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:598
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:26
Foam::IOobject::name
const word & name() const noexcept
Return the object name.
Definition: IOobjectI.H:195
Foam::nl
constexpr char nl
The newline &#39;\n&#39; character (0x0a)
Definition: Ostream.H:50
Foam::yn
dimensionedScalar yn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:299
BINARY_TYPE_OPERATOR_SF
#define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:526
Foam::sqrt
dimensionedScalar sqrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:137
Foam::pow025
dimensionedScalar pow025(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:126
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tf1, const word &name, const dimensionSet &dimensions, const bool initCopy=false)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:124
Foam::stabilise
dimensionedScalar stabilise(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:335
Foam::reuseTmpTmpDimensionedField::New
static tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< Type1, GeoMesh >> &tf1, const tmp< DimensionedField< Type2, GeoMesh >> &tf2, const word &name, const dimensionSet &dimensions)
Definition: DimensionedFieldReuseFunctions.H:145
Foam::y0
dimensionedScalar y0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:274
Foam::dimless
const dimensionSet dimless
Dimensionless.
Definition: dimensionSets.C:182
Foam::subtract
void subtract(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:912
Foam::posPart
dimensionedScalar posPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:214
Foam::neg
dimensionedScalar neg(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:192
Foam::asin
dimensionedScalar asin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:260
Foam::pow5
dimensionedScalar pow5(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:104
Foam::j1
dimensionedScalar j1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:273
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:170
Foam::acosh
dimensionedScalar acosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:267
Foam::cos
dimensionedScalar cos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:258
Foam::exp
dimensionedScalar exp(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:254
Foam::asinh
dimensionedScalar asinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:266
Foam::jn
dimensionedScalar jn(const int n, const dimensionedScalar &ds)
Definition: dimensionedScalar.C:298
Foam::cbrt
dimensionedScalar cbrt(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:148
Foam::neg0
dimensionedScalar neg0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:203
BesselFunc
#define BesselFunc(func)
Definition: DimensionedScalarField.C:749
Foam::atanh
dimensionedScalar atanh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:268
Foam::dimensioned::dimensions
const dimensionSet & dimensions() const noexcept
Return const reference to dimensions.
Definition: dimensionedType.H:356
Foam::y1
dimensionedScalar y1(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:275
Foam::DimensionedField::mesh
const Mesh & mesh() const noexcept
Return mesh.
Definition: DimensionedFieldI.H:34
Foam::pos0
dimensionedScalar pos0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:181
Foam::sin
dimensionedScalar sin(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:257
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:911
Foam::erf
dimensionedScalar erf(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:269
Foam::atan2
dimensionedScalar atan2(const dimensionedScalar &x, const dimensionedScalar &y)
Definition: dimensionedScalar.C:305
Foam::trans
dimensionSet trans(const dimensionSet &ds)
Check the argument is dimensionless (for transcendental functions)
Definition: dimensionSet.C:471
Foam::DimensionedField::field
const Field< Type > & field() const noexcept
Return const-reference to the field values.
Definition: DimensionedFieldI.H:88
Foam::dimensioned::name
const word & name() const noexcept
Return const reference to name.
Definition: dimensionedType.H:346
Foam::lgamma
dimensionedScalar lgamma(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:271
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:68
Foam::pow3
dimensionedScalar pow3(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:82
Foam::erfc
dimensionedScalar erfc(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:270
Foam::dimensionSet::checking
static bool checking() noexcept
True if dimension checking is enabled (the usual default)
Definition: dimensionSet.H:241
Foam::sinh
dimensionedScalar sinh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:263
Foam::dimensionedScalar
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Definition: dimensionedScalarFwd.H:33
Foam::atan
dimensionedScalar atan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:262
Foam::DimensionedField::New
static tmp< DimensionedField< Type, GeoMesh > > New(const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField)
Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field...
Definition: DimensionedFieldNew.C:72
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: areaFieldsFwd.H:42
Foam::pow4
dimensionedScalar pow4(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:93
Foam::pow6
dimensionedScalar pow6(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:115
DimensionedScalarField.H
Scalar specific part of the implementation of DimensionedField.
Foam::cosh
dimensionedScalar cosh(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:264
Foam::GeoMesh
Generic mesh wrapper used by volMesh, surfaceMesh, pointMesh etc.
Definition: GeoMesh.H:42
Foam::tmp
A class for managing temporary objects.
Definition: HashPtrTable.H:50
Foam::multiply
void multiply(DimensionedField< Type, GeoMesh > &result, const DimensionedField< Type, GeoMesh > &f1, const DimensionedField< scalar, GeoMesh > &f2)
s
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Definition: gmvOutputSpray.H:25
Foam::tan
dimensionedScalar tan(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:259
Foam::j0
dimensionedScalar j0(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:272
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:685
Foam::dimensionSet::dimensionless
bool dimensionless() const
Return true if it is dimensionless.
Definition: dimensionSet.C:107
Foam::log10
dimensionedScalar log10(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:256
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:26
Foam::negPart
dimensionedScalar negPart(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:225
Foam::DimensionedField::dimensions
const dimensionSet & dimensions() const noexcept
Return dimensions.
Definition: DimensionedFieldI.H:42