PolyFEM
Loading...
Searching...
No Matches
StateInit.cpp
Go to the documentation of this file.
2
6
9
14
16
17#include <jse/jse.h>
18#include <polyfem/embedded_spec/polyfem.hpp>
19
20#include <spdlog/sinks/stdout_color_sinks.h>
21#include <spdlog/sinks/basic_file_sink.h>
22#include <spdlog/sinks/ostream_sink.h>
23
24#include <ipc/utils/logger.hpp>
25#ifdef POLYFEM_WITH_ITR
26#include <wmtk/utils/Logger.hpp>
27#endif
28
31
32#include <sstream>
33
35{
36 NLOHMANN_JSON_SERIALIZE_ENUM(
37 spdlog::level::level_enum,
38 {{spdlog::level::level_enum::trace, "trace"},
39 {spdlog::level::level_enum::debug, "debug"},
40 {spdlog::level::level_enum::info, "info"},
41 {spdlog::level::level_enum::warn, "warning"},
42 {spdlog::level::level_enum::err, "error"},
43 {spdlog::level::level_enum::critical, "critical"},
44 {spdlog::level::level_enum::off, "off"},
45 {spdlog::level::level_enum::trace, 0},
46 {spdlog::level::level_enum::debug, 1},
47 {spdlog::level::level_enum::info, 2},
48 {spdlog::level::level_enum::warn, 3},
49 {spdlog::level::level_enum::err, 3},
50 {spdlog::level::level_enum::critical, 4},
51 {spdlog::level::level_enum::off, 5}})
52}
53
54namespace polyfem::legacy
55{
56 using namespace problem;
57 using namespace utils;
58
60 {
61 using namespace polysolve;
62
64
66 }
67
69 const std::string &log_file,
70 const spdlog::level::level_enum log_level,
71 const spdlog::level::level_enum file_log_level,
72 const bool is_quiet)
73 {
74 std::vector<spdlog::sink_ptr> sinks;
75
76 if (!is_quiet)
77 {
78 console_sink_ = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
79 sinks.emplace_back(console_sink_);
80 }
81
82 if (!log_file.empty())
83 {
84 file_sink_ = std::make_shared<spdlog::sinks::basic_file_sink_mt>(log_file, /*truncate=*/true);
85 // Set the file sink separately from the console so it can save all messages
86 file_sink_->set_level(file_log_level);
87 sinks.push_back(file_sink_);
88 }
89
90 init_logger(sinks, log_level);
91 spdlog::flush_every(std::chrono::seconds(3));
92 }
93
94 void State::init_logger(std::ostream &os, const spdlog::level::level_enum log_level)
95 {
96 std::vector<spdlog::sink_ptr> sinks;
97 sinks.emplace_back(std::make_shared<spdlog::sinks::ostream_sink_mt>(os, false));
98 init_logger(sinks, log_level);
99 }
100
102 const std::vector<spdlog::sink_ptr> &sinks,
103 const spdlog::level::level_enum log_level)
104 {
105 set_logger(std::make_shared<spdlog::logger>("polyfem", sinks.begin(), sinks.end()));
107
108 ipc::set_logger(std::make_shared<spdlog::logger>("ipctk", sinks.begin(), sinks.end()));
109
110#ifdef POLYFEM_WITH_ITR
111 wmtk::set_logger(std::make_shared<spdlog::logger>("wmtk", sinks.begin(), sinks.end()));
112#endif
113
114 // Set the logger at the lowest level, so all messages are passed to the sinks
115 logger().set_level(spdlog::level::trace);
116 ipc::logger().set_level(spdlog::level::trace);
117#ifdef POLYFEM_WITH_ITR
118 wmtk::logger().set_level(spdlog::level::trace);
119#endif
120
121 set_log_level(log_level);
122 }
123
124 void State::set_log_level(const spdlog::level::level_enum log_level)
125 {
126 spdlog::set_level(log_level);
127 if (console_sink_)
128 {
129 // Set only the level of the console
130 console_sink_->set_level(log_level); // Shared by all loggers
131 }
132 else
133 {
134 // Set the level of all sinks
135 logger().set_level(log_level);
136 ipc::logger().set_level(log_level);
137 }
138 }
139
140 void State::init(const json &p_args_in, const bool strict_validation)
141 {
142 json args_in = p_args_in; // mutable copy
143
144 has_constraints_ = p_args_in.contains("constraints");
145
146 apply_common_params(args_in);
147
148 // CHECK validity json
149 json rules;
150 jse::JSE jse;
151 {
152 jse.strict = strict_validation;
153 rules = jse::embed::polyfem_spec::polyfem::spec();
154
155 polysolve::linear::Solver::apply_default_solver(rules, "/solver/linear");
156 polysolve::linear::Solver::apply_default_solver(rules, "/solver/adjoint_linear");
157 }
158
159 polysolve::linear::Solver::select_valid_solver(args_in["solver"]["linear"], logger());
160 if (args_in["solver"]["adjoint_linear"].is_null())
161 args_in["solver"]["adjoint_linear"] = args_in["solver"]["linear"];
162 else
163 polysolve::linear::Solver::select_valid_solver(args_in["solver"]["adjoint_linear"], logger());
164
165 // Use the /solver/nonlinear settings as the default for /solver/augmented_lagrangian/nonlinear
166 if (args_in.contains("/solver/nonlinear"_json_pointer))
167 {
168 if (args_in.contains("/solver/augmented_lagrangian/nonlinear"_json_pointer))
169 {
170 assert(args_in["solver"]["augmented_lagrangian"]["nonlinear"].is_object());
171 // Merge the augmented lagrangian settings into the nonlinear settings,
172 // and then replace the augmented lagrangian settings with the merged settings.
173 json nonlinear = args_in["solver"]["nonlinear"]; // copy
174 nonlinear.merge_patch(args_in["solver"]["augmented_lagrangian"]["nonlinear"]);
175 args_in["solver"]["augmented_lagrangian"]["nonlinear"] = nonlinear;
176 }
177 else
178 {
179 // Copy the nonlinear settings to the augmented_lagrangian settings
180 args_in["solver"]["augmented_lagrangian"]["nonlinear"] = args_in["solver"]["nonlinear"];
181 }
182 }
183 const bool valid_input = jse.verify_json(args_in, rules);
184
185 if (!valid_input)
186 {
187 logger().error("invalid input json:\n{}", jse.log2str());
188 throw std::runtime_error("Invalid input json file");
189 }
190 // end of check
191
192 this->args = jse.inject_defaults(args_in, rules);
193 units.init(this->args["units"]);
194
195 if (!args_in.contains("/space/advanced/bc_method"_json_pointer) && this->args["space"]["basis_type"] != "Lagrange")
196 {
197 logger().warn("Setting bc method to lsq for non-Lagrange basis");
198 this->args["space"]["advanced"]["bc_method"] = "lsq";
199 }
200
201 // Save output directory and resolve output paths dynamically
202 const std::string output_dir = resolve_input_path(this->args["output"]["directory"]);
203 if (!output_dir.empty())
204 {
205 std::filesystem::create_directories(output_dir);
206 }
207 this->output_dir = output_dir;
208
209 std::string out_path_log = this->args["output"]["log"]["path"];
210 if (!out_path_log.empty())
211 {
212 out_path_log = resolve_output_path(out_path_log);
213 }
214
215 for (auto &path : this->args["constraints"]["hard"])
216 {
217 path = resolve_input_path(path);
218 }
219 for (auto &path : this->args["constraints"]["soft"])
220 {
221 path["data"] = resolve_input_path(path["data"]);
222 }
223
225 out_path_log,
226 this->args["output"]["log"]["level"],
227 this->args["output"]["log"]["file_level"],
228 this->args["output"]["log"]["quiet"]);
229
230 logger().info("Saving output to {}", output_dir);
231
232 const unsigned int thread_in = this->args["solver"]["max_threads"];
233 set_max_threads(thread_in);
234
235 has_dhat = args_in["contact"].contains("dhat");
236
237 init_time();
238
239 if (is_contact_enabled())
240 {
241 if (args["solver"]["contact"]["friction_iterations"] == 0)
242 {
243 logger().info("specified friction_iterations is 0; disabling friction");
244 args["contact"]["friction_coefficient"] = 0.0;
245 }
246 else if (args["solver"]["contact"]["friction_iterations"] < 0)
247 {
248 args["solver"]["contact"]["friction_iterations"] = std::numeric_limits<int>::max();
249 }
250 if (args["contact"]["friction_coefficient"] == 0.0)
251 {
252 args["solver"]["contact"]["friction_iterations"] = 0;
253 }
254 }
255 else
256 {
257 args["solver"]["contact"]["friction_iterations"] = 0;
258 args["contact"]["friction_coefficient"] = 0;
259 args["contact"]["periodic"] = false;
260 }
261
262 const std::string formulation = this->formulation();
264 assert(assembler->name() == formulation);
265 mass_matrix_assembler = std::make_shared<assembler::Mass>();
266 pure_mass_matrix_assembler = std::make_shared<assembler::HRZMass>();
268
269 if (!other_name.empty())
270 {
273 }
274
275 if (args["solver"]["advanced"]["check_inversion"] == "Conservative")
276 {
277 if (auto elastic_assembler = std::dynamic_pointer_cast<assembler::ElasticityAssembler>(assembler))
278 elastic_assembler->set_use_robust_jacobian();
279 }
280
281 if (!args.contains("preset_problem"))
282 {
283 if (!assembler->is_tensor())
284 problem = std::make_shared<assembler::GenericScalarProblem>("GenericScalar");
285 else
286 problem = std::make_shared<assembler::GenericTensorProblem>("GenericTensor");
287
288 problem->clear();
289 if (!args["time"].is_null())
290 {
291 const auto tmp = R"({"is_time_dependent": true})"_json;
292 problem->set_parameters(tmp, root_path());
293 }
294 // important for the BC
295
296 auto bc = args["boundary_conditions"];
297 bc["root_path"] = root_path();
298 problem->set_parameters(bc, root_path());
299 problem->set_parameters(args["initial_conditions"], root_path());
300
301 problem->set_parameters(args["output"], root_path());
302 }
303 else
304 {
305 if (args["preset_problem"]["type"] == "Kernel")
306 {
307 problem = std::make_shared<KernelProblem>("Kernel", *assembler);
308 problem->clear();
309 KernelProblem &kprob = *dynamic_cast<KernelProblem *>(problem.get());
310 }
311 else
312 {
313 problem = ProblemFactory::factory().get_problem(args["preset_problem"]["type"]);
314 problem->clear();
315 }
316 // important for the BC
317 problem->set_parameters(args["preset_problem"], root_path());
318 }
319
320 problem->set_units(*assembler, units);
321 }
322
323 void State::set_max_threads(const int max_threads)
324 {
325 NThread::get().set_num_threads(max_threads);
326 }
327
329 {
330 if (!is_param_valid(args, "time"))
331 return;
332
333 const double t0 = Units::convert(args["time"]["t0"], units.time());
334 double tend, dt;
335 int time_steps;
336
337 // from "tend", "dt", "time_steps" only two can be used at a time
338 const int num_valid = is_param_valid(args["time"], "tend")
339 + is_param_valid(args["time"], "dt")
340 + is_param_valid(args["time"], "time_steps");
341 if (num_valid < 2)
342 {
343 log_and_throw_error("Exactly two of (tend, dt, time_steps) must be specified");
344 }
345 else if (num_valid == 2)
346 {
347 if (is_param_valid(args["time"], "tend"))
348 {
349 tend = Units::convert(args["time"]["tend"], units.time());
350 assert(tend > t0);
351 if (is_param_valid(args["time"], "dt"))
352 {
353 dt = Units::convert(args["time"]["dt"], units.time());
354 assert(dt > 0);
355 time_steps = int(ceil((tend - t0) / dt));
356 assert(time_steps > 0);
357 }
358 else if (is_param_valid(args["time"], "time_steps"))
359 {
360 time_steps = args["time"]["time_steps"];
361 assert(time_steps > 0);
362 dt = (tend - t0) / time_steps;
363 assert(dt > 0);
364 }
365 else
366 {
367 throw std::runtime_error("This code should be unreachable!");
368 }
369 }
370 else if (is_param_valid(args["time"], "dt"))
371 {
372 // tend is already confirmed to be invalid, so time_steps must be valid
373 assert(is_param_valid(args["time"], "time_steps"));
374
375 dt = Units::convert(args["time"]["dt"], units.time());
376 assert(dt > 0);
377
378 time_steps = args["time"]["time_steps"];
379 assert(time_steps > 0);
380
381 tend = t0 + time_steps * dt;
382 }
383 else
384 {
385 // tend and dt are already confirmed to be invalid
386 throw std::runtime_error("This code should be unreachable!");
387 }
388 }
389 else if (num_valid == 3)
390 {
391 tend = Units::convert(args["time"]["tend"], units.time());
392 dt = Units::convert(args["time"]["dt"], units.time());
393 time_steps = args["time"]["time_steps"];
394
395 // Check that all parameters agree
396 if (abs(t0 + dt * time_steps - tend) > 1e-12)
397 {
398 log_and_throw_error("Exactly two of (tend, dt, time_steps) must be specified");
399 }
400 }
401
402 // Store these for use later
403 args["time"]["tend"] = tend;
404 args["time"]["dt"] = dt;
405 args["time"]["time_steps"] = time_steps;
406
408
409 logger().info("t0={}, dt={}, tend={}", t0, dt, tend);
410 }
411
412 void State::set_materials(std::vector<std::shared_ptr<assembler::Assembler>> &assemblers) const
413 {
414 const int size = (assembler->is_tensor() || assembler->is_fluid()) ? mesh->dimension() : 1;
415 for (auto &a : assemblers)
416 a->set_size(size);
417
418 if (!utils::is_param_valid(args, "materials"))
419 return;
420
421 std::vector<int> body_ids(mesh->n_elements());
422 for (int i = 0; i < mesh->n_elements(); ++i)
423 body_ids[i] = mesh->get_body_id(i);
424
425 for (auto &a : assemblers)
426 a->set_materials(body_ids, args["materials"], units, root_path());
427 }
428
430 {
431 const int size = (this->assembler->is_tensor() || this->assembler->is_fluid()) ? this->mesh->dimension() : 1;
432 assembler.set_size(size);
433
434 if (!utils::is_param_valid(args, "materials"))
435 return;
436
437 std::vector<int> body_ids(mesh->n_elements());
438 for (int i = 0; i < mesh->n_elements(); ++i)
439 body_ids[i] = mesh->get_body_id(i);
440
441 assembler.set_materials(body_ids, args["materials"], units, root_path());
442 }
443
444} // namespace polyfem::legacy
void init(const json &json)
Definition Units.cpp:9
double characteristic_length() const
Definition Units.hpp:22
static double convert(const json &val, const std::string &unit_type)
Definition Units.cpp:31
const std::string & time() const
Definition Units.hpp:21
virtual bool is_tensor() const
virtual void set_size(const int size)
Definition Assembler.hpp:64
virtual bool is_fluid() const
static std::shared_ptr< MixedAssembler > make_mixed_assembler(const std::string &formulation)
static std::string other_assembler_name(const std::string &formulation)
static std::shared_ptr< Assembler > make_assembler(const std::string &formulation)
std::shared_ptr< assembler::Problem > problem
current problem, it contains rhs and bc
Definition State.hpp:204
void init(const json &args, const bool strict_validation)
initialize the polyfem solver with a json settings
bool has_dhat
stores if input json contains dhat
Definition State.hpp:731
std::string resolve_input_path(const std::string &path, const bool only_if_exists=false) const
Resolve input path relative to root_path() if the path is not absolute.
std::shared_ptr< assembler::Mass > mass_matrix_assembler
Definition State.hpp:192
std::unique_ptr< mesh::Mesh > mesh
current mesh, it can be a Mesh2D or Mesh3D
Definition State.hpp:594
json args
main input arguments containing all defaults
Definition State.hpp:136
void set_max_threads(const int max_threads=std::numeric_limits< int >::max())
void set_log_level(const spdlog::level::level_enum log_level)
change log level
std::string resolve_output_path(const std::string &path) const
Resolve output path relative to output_dir if the path is not absolute.
std::string root_path() const
Get the root path for the state (e.g., args["root_path"] or ".")
std::shared_ptr< assembler::Assembler > pressure_assembler
Definition State.hpp:196
std::string formulation() const
return the formulation (checks if the problem is scalar or not and deals with multiphysics)
Definition State.cpp:332
std::shared_ptr< assembler::Assembler > assembler
assemblers
Definition State.hpp:190
void set_materials(std::vector< std::shared_ptr< assembler::Assembler > > &assemblers) const
set the material and the problem dimension
void init_logger(const std::string &log_file, const spdlog::level::level_enum log_level, const spdlog::level::level_enum file_log_level, const bool is_quiet)
initializing the logger
Definition StateInit.cpp:68
std::string output_dir
Directory for output files.
Definition State.hpp:738
void init_time()
initialize time settings if args contains "time"
spdlog::sink_ptr console_sink_
logger sink to stdout
Definition State.hpp:177
std::shared_ptr< assembler::HRZMass > pure_mass_matrix_assembler
Definition State.hpp:193
spdlog::sink_ptr file_sink_
Definition State.hpp:178
bool is_contact_enabled() const
does the simulation have contact
Definition State.hpp:708
std::shared_ptr< assembler::MixedAssembler > mixed_assembler
Definition State.hpp:195
State()
Constructor.
Definition StateInit.cpp:59
static const ProblemFactory & factory()
std::shared_ptr< assembler::Problem > get_problem(const std::string &problem) const
void set_logger(spdlog::logger &logger)
static GeogramUtils & instance()
static NThread & get()
Definition par_for.hpp:19
void set_num_threads(const int max_threads)
Definition par_for.hpp:27
bool is_param_valid(const json &params, const std::string &key)
Determine if a key exists and is non-null in a json object.
void apply_common_params(json &args)
Definition JSONUtils.cpp:14
spdlog::logger & logger()
Retrieves the current logger.
Definition Logger.cpp:44
nlohmann::json json
Definition Common.hpp:9
void set_logger(std::shared_ptr< spdlog::logger > p_logger)
Setup a logger object to be used by Polyfem.
Definition Logger.cpp:62
void log_and_throw_error(const std::string &msg)
Definition Logger.cpp:73