https://mooseframework.inl.gov
ADFParser.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ADFParser.h"
11 #include "MooseUtils.h"
12 #include "ExecutablePath.h"
13 
14 ADFParser::ADFParser() : FunctionParserAD(), _epsilon(1e-12) {}
15 
16 ADFParser::ADFParser(const ADFParser & cpy) : FunctionParserAD(cpy), _epsilon(1e-12) {}
17 
18 #ifndef ADFPARSER_INCLUDES
19 #error ... \
20  The ADFPARSER_INCLUDES macro is not defined. A possible reason is that you \
21  are compiling MOOSE from a custom application. Please check your application \
22  Makefile and make sure that you are appending options to ADDITIONAL_CPPFLAGS \
23  using the += operator, rather than overwriting the variable with the := operator.
24 #endif
25 
26 bool
28 {
29 #if LIBMESH_HAVE_FPARSER_JIT
30  std::string includes;
31  const auto type_hash = typeid(ADReal).hash_code();
32  bool result;
33 
34  std::string fopenmp;
35 #if defined(_OPENMP)
36  fopenmp = "-fopenmp";
37 #endif
38 
39  const auto include_path_env = std::getenv("MOOSE_ADFPARSER_JIT_INCLUDE");
40  if (include_path_env)
41  result = JITCompileHelper(
42  "ADReal", fopenmp, "#include \"" + std::string(include_path_env) + "\"\n", type_hash);
43  else
44  {
45  // check if we can find an installed version of the monolithic include
46  const std::string include_path =
47  MooseUtils::pathjoin(Moose::getExecutablePath(), "../include/moose/ADRealMonolithic.h");
48  if (MooseUtils::checkFileReadable(include_path, false, false, false))
49  result =
50  JITCompileHelper("ADReal", fopenmp, "#include \"" + include_path + "\"\n", type_hash);
51  else
52  // otherwise use the compiled in location from the source tree
53  result = JITCompileHelper(
54  "ADReal", fopenmp + " " + ADFPARSER_INCLUDES, "#include \"ADReal.h\"\n", type_hash);
55  }
56 
57  if (!result)
58 #endif
59  mooseError("ADFParser::JITCompile() failed. Evaluation not possible.");
60 
61  return true;
62 }
63 
64 ADReal
66 {
67  mooseAssert(compiledFunction, "ADFParser objects must be JIT compiled before evaluation!");
68  ADReal ret;
69  (*reinterpret_cast<CompiledFunctionPtr<ADReal>>(compiledFunction))(&ret, vars, pImmed, _epsilon);
70  return ret;
71 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:302
std::string getExecutablePath()
This function returns the PATH of the running executable.
char ** vars
ADFParser()
Definition: ADFParser.C:14
const Real _epsilon
Definition: ADFParser.h:29
DualNumber< Real, DNDerivativeType, true > ADReal
Definition: ADRealForward.h:47
bool JITCompile()
Definition: ADFParser.C:27
Real Eval(const Real *)
Definition: ADFParser.h:25
bool checkFileReadable(const std::string &filename, bool check_line_endings=false, bool throw_on_unreadable=true, bool check_for_git_lfs_pointer=true)
Checks to see if a file is readable (exists and permissions)
Definition: MooseUtils.C:250
std::filesystem::path pathjoin(const std::filesystem::path &p)
Definition: MooseUtils.C:59