PolyFEM
Loading...
Searching...
No Matches
StateInit.cpp
Go to the documentation of this file.
1#include <polyfem/State.hpp>
2
6
9
14
16
17#include <jse/jse.h>
18
19#include <spdlog/sinks/stdout_color_sinks.h>
20#include <spdlog/sinks/basic_file_sink.h>
21#include <spdlog/sinks/ostream_sink.h>
22
23#include <ipc/utils/logger.hpp>
24#include <wmtk/utils/Logger.hpp>
25
28
29#include <sstream>
30
31namespace spdlog::level
32{
34 spdlog::level::level_enum,
35 {{spdlog::level::level_enum::trace, "trace"},
36 {spdlog::level::level_enum::debug, "debug"},
37 {spdlog::level::level_enum::info, "info"},
38 {spdlog::level::level_enum::warn, "warning"},
39 {spdlog::level::level_enum::err, "error"},
40 {spdlog::level::level_enum::critical, "critical"},
41 {spdlog::level::level_enum::off, "off"},
42 {spdlog::level::level_enum::trace, 0},
43 {spdlog::level::level_enum::debug, 1},
44 {spdlog::level::level_enum::info, 2},
45 {spdlog::level::level_enum::warn, 3},
46 {spdlog::level::level_enum::err, 3},
47 {spdlog::level::level_enum::critical, 4},
48 {spdlog::level::level_enum::off, 5}})
49}
50
51namespace polyfem
52{
53 using namespace problem;
54 using namespace utils;
55
57 {
58 using namespace polysolve;
59
61
63 }
64
66 const std::string &log_file,
67 const spdlog::level::level_enum log_level,
68 const spdlog::level::level_enum file_log_level,
69 const bool is_quiet)
70 {
71 std::vector<spdlog::sink_ptr> sinks;
72
73 if (!is_quiet)
74 {
75 console_sink_ = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
76 sinks.emplace_back(console_sink_);
77 }
78
79 if (!log_file.empty())
80 {
81 file_sink_ = std::make_shared<spdlog::sinks::basic_file_sink_mt>(log_file, /*truncate=*/true);
82 // Set the file sink separately from the console so it can save all messages
83 file_sink_->set_level(file_log_level);
84 sinks.push_back(file_sink_);
85 }
86
87 init_logger(sinks, log_level);
88 spdlog::flush_every(std::chrono::seconds(3));
89 }
90
91 void State::init_logger(std::ostream &os, const spdlog::level::level_enum log_level)
92 {
93 std::vector<spdlog::sink_ptr> sinks;
94 sinks.emplace_back(std::make_shared<spdlog::sinks::ostream_sink_mt>(os, false));
95 init_logger(sinks, log_level);
96 }
97
99 const std::vector<spdlog::sink_ptr> &sinks,
100 const spdlog::level::level_enum log_level)
101 {
102 set_logger(std::make_shared<spdlog::logger>("polyfem", sinks.begin(), sinks.end()));
104
105 ipc::set_logger(std::make_shared<spdlog::logger>("ipctk", sinks.begin(), sinks.end()));
106
107 wmtk::set_logger(std::make_shared<spdlog::logger>("wmtk", sinks.begin(), sinks.end()));
108
109 // Set the logger at the lowest level, so all messages are passed to the sinks
110 logger().set_level(spdlog::level::trace);
111 ipc::logger().set_level(spdlog::level::trace);
112 wmtk::logger().set_level(spdlog::level::trace);
113
114 set_log_level(log_level);
115 }
116
117 void State::set_log_level(const spdlog::level::level_enum log_level)
118 {
119 spdlog::set_level(log_level);
120 if (console_sink_)
121 {
122 // Set only the level of the console
123 console_sink_->set_level(log_level); // Shared by all loggers
124 }
125 else
126 {
127 // Set the level of all sinks
128 logger().set_level(log_level);
129 ipc::logger().set_level(log_level);
130 }
131 }
132
133 void State::init(const json &p_args_in, const bool strict_validation)
134 {
135 json args_in = p_args_in; // mutable copy
136
137 apply_common_params(args_in);
138
139 // CHECK validity json
140 json rules;
141 jse::JSE jse;
142 {
143 jse.strict = strict_validation;
144 const std::string polyfem_input_spec = POLYFEM_INPUT_SPEC;
145 std::ifstream file(polyfem_input_spec);
146
147 if (file.is_open())
148 file >> rules;
149 else
150 {
151 logger().error("unable to open {} rules", polyfem_input_spec);
152 throw std::runtime_error("Invald spec file");
153 }
154
155 jse.include_directories.push_back(POLYFEM_JSON_SPEC_DIR);
156 jse.include_directories.push_back(POLYSOLVE_JSON_SPEC_DIR);
157 rules = jse.inject_include(rules);
158
159 polysolve::linear::Solver::apply_default_solver(rules, "/solver/linear");
160 polysolve::linear::Solver::apply_default_solver(rules, "/solver/adjoint_linear");
161 }
162
163 polysolve::linear::Solver::select_valid_solver(args_in["solver"]["linear"], logger());
164 if (args_in["solver"]["adjoint_linear"].is_null())
165 args_in["solver"]["adjoint_linear"] = args_in["solver"]["linear"];
166 else
167 polysolve::linear::Solver::select_valid_solver(args_in["solver"]["adjoint_linear"], logger());
168
169 // Use the /solver/nonlinear settings as the default for /solver/augmented_lagrangian/nonlinear
170 if (args_in.contains("/solver/nonlinear"_json_pointer))
171 {
172 if (args_in.contains("/solver/augmented_lagrangian/nonlinear"_json_pointer))
173 {
174 assert(args_in["solver"]["augmented_lagrangian"]["nonlinear"].is_object());
175 // Merge the augmented lagrangian settings into the nonlinear settings,
176 // and then replace the augmented lagrangian settings with the merged settings.
177 json nonlinear = args_in["solver"]["nonlinear"]; // copy
178 nonlinear.merge_patch(args_in["solver"]["augmented_lagrangian"]["nonlinear"]);
179 args_in["solver"]["augmented_lagrangian"]["nonlinear"] = nonlinear;
180 }
181 else
182 {
183 // Copy the nonlinear settings to the augmented_lagrangian settings
184 args_in["solver"]["augmented_lagrangian"]["nonlinear"] = args_in["solver"]["nonlinear"];
185 }
186 }
187
188 const bool valid_input = jse.verify_json(args_in, rules);
189
190 if (!valid_input)
191 {
192 logger().error("invalid input json:\n{}", jse.log2str());
193 throw std::runtime_error("Invald input json file");
194 }
195 // end of check
196
197 this->args = jse.inject_defaults(args_in, rules);
198 units.init(this->args["units"]);
199
200 // Save output directory and resolve output paths dynamically
201 const std::string output_dir = resolve_input_path(this->args["output"]["directory"]);
202 if (!output_dir.empty())
203 {
204 std::filesystem::create_directories(output_dir);
205 }
206 this->output_dir = output_dir;
207
208 std::string out_path_log = this->args["output"]["log"]["path"];
209 if (!out_path_log.empty())
210 {
211 out_path_log = resolve_output_path(out_path_log);
212 }
213
215 out_path_log,
216 this->args["output"]["log"]["level"],
217 this->args["output"]["log"]["file_level"],
218 this->args["output"]["log"]["quiet"]);
219
220 logger().info("Saving output to {}", output_dir);
221
222 const unsigned int thread_in = this->args["solver"]["max_threads"];
223 set_max_threads(thread_in);
224
225 has_dhat = args_in["contact"].contains("dhat");
226
227 init_time();
228
229 if (is_contact_enabled())
230 {
231 if (args["solver"]["contact"]["friction_iterations"] == 0)
232 {
233 logger().info("specified friction_iterations is 0; disabling friction");
234 args["contact"]["friction_coefficient"] = 0.0;
235 }
236 else if (args["solver"]["contact"]["friction_iterations"] < 0)
237 {
238 args["solver"]["contact"]["friction_iterations"] = std::numeric_limits<int>::max();
239 }
240 if (args["contact"]["friction_coefficient"] == 0.0)
241 {
242 args["solver"]["contact"]["friction_iterations"] = 0;
243 }
244 }
245 else
246 {
247 args["solver"]["contact"]["friction_iterations"] = 0;
248 args["contact"]["friction_coefficient"] = 0;
249 args["contact"]["periodic"] = false;
250 }
251
252 const std::string formulation = this->formulation();
254 assert(assembler->name() == formulation);
255 mass_matrix_assembler = std::make_shared<assembler::Mass>();
257
258 if (!other_name.empty())
259 {
262 }
263
264 if (!args.contains("preset_problem"))
265 {
266 if (!assembler->is_tensor())
267 problem = std::make_shared<assembler::GenericScalarProblem>("GenericScalar");
268 else
269 problem = std::make_shared<assembler::GenericTensorProblem>("GenericTensor");
270
271 problem->clear();
272 if (!args["time"].is_null())
273 {
274 const auto tmp = R"({"is_time_dependent": true})"_json;
275 problem->set_parameters(tmp);
276 }
277 // important for the BC
278
279 auto bc = args["boundary_conditions"];
280 bc["root_path"] = root_path();
281 problem->set_parameters(bc);
282 problem->set_parameters(args["initial_conditions"]);
283
284 problem->set_parameters(args["output"]);
285 }
286 else
287 {
288 if (args["preset_problem"]["type"] == "Kernel")
289 {
290 problem = std::make_shared<KernelProblem>("Kernel", *assembler);
291 problem->clear();
292 KernelProblem &kprob = *dynamic_cast<KernelProblem *>(problem.get());
293 }
294 else
295 {
296 problem = ProblemFactory::factory().get_problem(args["preset_problem"]["type"]);
297 problem->clear();
298 }
299 // important for the BC
300 problem->set_parameters(args["preset_problem"]);
301 }
302
303 problem->set_units(*assembler, units);
304
306 {
307 if (is_contact_enabled())
308 {
309 if (!args["contact"]["use_convergent_formulation"])
310 {
311 args["contact"]["use_convergent_formulation"] = true;
312 logger().info("Use convergent formulation for differentiable contact...");
313 }
314 if (args["/solver/contact/barrier_stiffness"_json_pointer].is_string())
315 {
316 logger().error("Only constant barrier stiffness is supported in differentiable contact!");
317 }
318 }
319
320 if (args.contains("boundary_conditions") && args["boundary_conditions"].contains("rhs"))
321 {
322 json rhs = args["boundary_conditions"]["rhs"];
323 if ((rhs.is_array() && rhs.size() > 0 && rhs[0].is_string()) || rhs.is_string())
324 logger().error("Only constant rhs over space is supported in differentiable code!");
325 }
326 }
327 }
328
329 void State::set_max_threads(const int max_threads)
330 {
331 NThread::get().set_num_threads(max_threads);
332 }
333
335 {
336 if (!is_param_valid(args, "time"))
337 return;
338
339 const double t0 = Units::convert(args["time"]["t0"], units.time());
340 double tend, dt;
341 int time_steps;
342
343 // from "tend", "dt", "time_steps" only two can be used at a time
344 const int num_valid = is_param_valid(args["time"], "tend")
345 + is_param_valid(args["time"], "dt")
346 + is_param_valid(args["time"], "time_steps");
347 if (num_valid < 2)
348 {
349 log_and_throw_error("Exactly two of (tend, dt, time_steps) must be specified");
350 }
351 else if (num_valid == 2)
352 {
353 if (is_param_valid(args["time"], "tend"))
354 {
355 tend = Units::convert(args["time"]["tend"], units.time());
356 assert(tend > t0);
357 if (is_param_valid(args["time"], "dt"))
358 {
359 dt = Units::convert(args["time"]["dt"], units.time());
360 assert(dt > 0);
361 time_steps = int(ceil((tend - t0) / dt));
362 assert(time_steps > 0);
363 }
364 else if (is_param_valid(args["time"], "time_steps"))
365 {
366 time_steps = args["time"]["time_steps"];
367 assert(time_steps > 0);
368 dt = (tend - t0) / time_steps;
369 assert(dt > 0);
370 }
371 else
372 {
373 throw std::runtime_error("This code should be unreachable!");
374 }
375 }
376 else if (is_param_valid(args["time"], "dt"))
377 {
378 // tend is already confirmed to be invalid, so time_steps must be valid
379 assert(is_param_valid(args["time"], "time_steps"));
380
381 dt = Units::convert(args["time"]["dt"], units.time());
382 assert(dt > 0);
383
384 time_steps = args["time"]["time_steps"];
385 assert(time_steps > 0);
386
387 tend = t0 + time_steps * dt;
388 }
389 else
390 {
391 // tend and dt are already confirmed to be invalid
392 throw std::runtime_error("This code should be unreachable!");
393 }
394 }
395 else if (num_valid == 3)
396 {
397 tend = Units::convert(args["time"]["tend"], units.time());
398 dt = Units::convert(args["time"]["dt"], units.time());
399 time_steps = args["time"]["time_steps"];
400
401 // Check that all parameters agree
402 if (abs(t0 + dt * time_steps - tend) > 1e-12)
403 {
404 log_and_throw_error("Exactly two of (tend, dt, time_steps) must be specified");
405 }
406 }
407
408 // Store these for use later
409 args["time"]["tend"] = tend;
410 args["time"]["dt"] = dt;
411 args["time"]["time_steps"] = time_steps;
412
414
415 logger().info("t0={}, dt={}, tend={}", t0, dt, tend);
416 }
417
418 void State::set_materials(std::vector<std::shared_ptr<assembler::Assembler>> &assemblers) const
419 {
420 const int size = (assembler->is_tensor() || assembler->is_fluid()) ? mesh->dimension() : 1;
421 for (auto &a : assemblers)
422 a->set_size(size);
423
424 if (!utils::is_param_valid(args, "materials"))
425 return;
426
427 if (!args["materials"].is_array() && args["materials"]["type"] == "AMIPSAutodiff")
428 {
429 json transform_params = {};
430 transform_params["canonical_transformation"] = json::array();
431 if (!mesh->is_volume())
432 {
433 Eigen::MatrixXd regular_tri(3, 3);
434 regular_tri << 0, 0, 1,
435 1, 0, 1,
436 1. / 2., std::sqrt(3) / 2., 1;
437 regular_tri.transposeInPlace();
438 Eigen::MatrixXd regular_tri_inv = regular_tri.inverse();
439
440 const auto &mesh2d = *dynamic_cast<mesh::Mesh2D *>(mesh.get());
441 for (int e = 0; e < mesh->n_elements(); e++)
442 {
443 Eigen::MatrixXd transform;
444 mesh2d.compute_face_jacobian(e, regular_tri_inv, transform);
445 transform_params["canonical_transformation"].push_back(json({
446 {
447 transform(0, 0),
448 transform(0, 1),
449 },
450 {
451 transform(1, 0),
452 transform(1, 1),
453 },
454 }));
455 }
456 }
457 else
458 {
459 Eigen::MatrixXd regular_tet(4, 4);
460 regular_tet << 0, 0, 0, 1,
461 1, 0, 0, 1,
462 1. / 2., std::sqrt(3) / 2., 0, 1,
463 1. / 2., 1. / 2. / std::sqrt(3), std::sqrt(3) / 2., 1;
464 regular_tet.transposeInPlace();
465 Eigen::MatrixXd regular_tet_inv = regular_tet.inverse();
466
467 const auto &mesh3d = *dynamic_cast<mesh::Mesh3D *>(mesh.get());
468 for (int e = 0; e < mesh->n_elements(); e++)
469 {
470 Eigen::MatrixXd transform;
471 mesh3d.compute_cell_jacobian(e, regular_tet_inv, transform);
472 transform_params["canonical_transformation"].push_back(json({
473 {
474 transform(0, 0),
475 transform(0, 1),
476 transform(0, 2),
477 },
478 {
479 transform(1, 0),
480 transform(1, 1),
481 transform(1, 2),
482 },
483 {
484 transform(2, 0),
485 transform(2, 1),
486 transform(2, 2),
487 },
488 }));
489 }
490 }
491 transform_params["solve_displacement"] = true;
492 assembler->set_materials({}, transform_params, units);
493
494 return;
495 }
496
497 std::vector<int> body_ids(mesh->n_elements());
498 for (int i = 0; i < mesh->n_elements(); ++i)
499 body_ids[i] = mesh->get_body_id(i);
500
501 for (auto &a : assemblers)
502 a->set_materials(body_ids, args["materials"], units);
503 }
504
506 {
507 const int size = (this->assembler->is_tensor() || this->assembler->is_fluid()) ? this->mesh->dimension() : 1;
508 assembler.set_size(size);
509
510 if (!utils::is_param_valid(args, "materials"))
511 return;
512
513 std::vector<int> body_ids(mesh->n_elements());
514 for (int i = 0; i < mesh->n_elements(); ++i)
515 body_ids[i] = mesh->get_body_id(i);
516
517 assembler.set_materials(body_ids, args["materials"], units);
518 }
519
520} // namespace polyfem
std::string formulation() const
return the formulation (checks if the problem is scalar or not and deals with multiphysics)
Definition State.cpp:328
void init(const json &args, const bool strict_validation)
initialize the polyfem solver with a json settings
std::string root_path() const
Get the root path for the state (e.g., args["root_path"] or ".")
std::shared_ptr< assembler::Assembler > assembler
assemblers
Definition State.hpp:155
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 output_dir
Directory for output files.
Definition State.hpp:573
solver::CacheLevel optimization_enabled
Definition State.hpp:647
void set_materials(std::vector< std::shared_ptr< assembler::Assembler > > &assemblers) const
set the material and the problem dimension
void set_max_threads(const int max_threads=std::numeric_limits< int >::max())
std::shared_ptr< assembler::Assembler > pressure_assembler
Definition State.hpp:160
std::shared_ptr< assembler::Mass > mass_matrix_assembler
Definition State.hpp:157
bool has_dhat
stores if input json contains dhat
Definition State.hpp:566
std::unique_ptr< mesh::Mesh > mesh
current mesh, it can be a Mesh2D or Mesh3D
Definition State.hpp:466
std::shared_ptr< assembler::Problem > problem
current problem, it contains rhs and bc
Definition State.hpp:168
spdlog::sink_ptr file_sink_
Definition State.hpp:143
spdlog::sink_ptr console_sink_
logger sink to stdout
Definition State.hpp:142
State()
Constructor.
Definition StateInit.cpp:56
json args
main input arguments containing all defaults
Definition State.hpp:101
void set_log_level(const spdlog::level::level_enum log_level)
change log level
void init_time()
initialize time settings if args contains "time"
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.
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:65
bool is_contact_enabled() const
does the simulation has contact
Definition State.hpp:551
std::shared_ptr< assembler::MixedAssembler > mixed_assembler
Definition State.hpp:159
Eigen::MatrixXd rhs
System right-hand side.
Definition State.hpp:207
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)
void compute_face_jacobian(const int el_id, const Eigen::MatrixXd &reference_map, Eigen::MatrixXd &jacobian) const
Definition Mesh2D.cpp:101
void compute_cell_jacobian(const int el_id, const Eigen::MatrixXd &reference_map, Eigen::MatrixXd &jacobian) const
Definition Mesh3D.cpp:424
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
NLOHMANN_JSON_SERIALIZE_ENUM(CollisionProxyTessellation, {{CollisionProxyTessellation::REGULAR, "regular"}, {CollisionProxyTessellation::IRREGULAR, "irregular"}})
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:42
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:60
void log_and_throw_error(const std::string &msg)
Definition Logger.cpp:71