12#include "cantera/oneD/refine.h"
32 for (
size_t n = 0; n <
nDomains(); n++) {
42 "Index out of bounds: {} > {}", iloc,
m_state->size());
43 (*m_state)[iloc] = value;
50 "Index out of bounds: {} > {}", iloc,
m_state->size());
58 "Index out of bounds: {} > {}", iloc,
m_state->size());
62void Sim1D::save(
const string& fname,
const string& name,
const string& desc,
63 bool overwrite,
int compression,
const string& basis)
65 size_t dot = fname.find_last_of(
".");
67 if (extension ==
"csv") {
68 for (
auto dom :
m_dom) {
69 auto arr = dom->toArray();
70 if (dom->size() > 1) {
71 arr->writeEntry(fname, overwrite, basis);
79 "Species basis '{}' not implemented for HDF5 or YAML output.", basis);
81 if (extension ==
"h5" || extension ==
"hdf" || extension ==
"hdf5") {
83 for (
auto dom :
m_dom) {
84 auto arr = dom->toArray();
85 arr->writeEntry(fname, name, dom->id(), overwrite, compression);
89 if (extension ==
"yaml" || extension ==
"yml") {
92 if (std::ifstream(fname).good()) {
97 for (
auto dom :
m_dom) {
98 auto arr = dom->toArray();
99 arr->writeEntry(data, name, dom->id(), overwrite);
103 std::ofstream out(fname);
104 out << data.toYamlString();
108 throw CanteraError(
"Sim1D::save",
"Unsupported file format '{}'.", extension);
112 const string& desc,
bool overwrite,
int compression)
114 vector<double> res(
m_state->size(), -999);
118 vector<double> backup(*
m_state);
120 save(fname, name, desc, overwrite, compression);
127AnyMap legacyH5(shared_ptr<SolutionArray> arr,
const AnyMap& header={})
129 auto meta = arr->meta();
132 map<string, string> meta_pairs = {
133 {
"type",
"Domain1D_type"},
135 {
"emissivity-left",
"emissivity_left"},
136 {
"emissivity-right",
"emissivity_right"},
138 for (
const auto& [newName, oldName] : meta_pairs) {
139 if (meta.hasKey(oldName)) {
140 out[newName] = meta[oldName];
144 map<string, string> tol_pairs = {
145 {
"transient-abstol",
"transient_abstol"},
146 {
"steady-abstol",
"steady_abstol"},
147 {
"transient-reltol",
"transient_reltol"},
148 {
"steady-reltol",
"steady_reltol"},
150 for (
const auto& [newName, oldName] : tol_pairs) {
151 if (meta.hasKey(oldName)) {
152 out[
"tolerances"][newName] = meta[oldName];
156 if (meta.hasKey(
"phase")) {
157 out[
"phase"][
"name"] = meta[
"phase"][
"name"];
158 out[
"phase"][
"source"] = meta[
"phase"][
"source"];
161 if (arr->size() <= 1) {
165 map<string, string> header_pairs = {
166 {
"transport-model",
"transport_model"},
167 {
"radiation-enabled",
"radiation_enabled"},
168 {
"energy-enabled",
"energy_enabled"},
169 {
"Soret-enabled",
"soret_enabled"},
171 for (
const auto& [newName, oldName] : header_pairs) {
172 if (header.hasKey(oldName)) {
173 out[newName] = header[oldName];
177 map<string, string> refiner_pairs = {
183 {
"max-points",
"max_grid_points"},
185 for (
const auto& [newName, oldName] : refiner_pairs) {
186 if (header.hasKey(oldName)) {
187 out[
"refine-criteria"][newName] = header[oldName];
191 if (header.hasKey(
"fixed_temperature")) {
192 double temp = header.
getDouble(
"fixed_temperature", -1.);
193 auto profile = arr->getComponent(
"T").as<vector<double>>();
195 while (profile[ix] <= temp && ix < arr->size()) {
199 auto grid = arr->getComponent(
"grid").as<vector<double>>();
200 out[
"fixed-point"][
"location"] = grid[ix - 1];
201 out[
"fixed-point"][
"temperature"] = temp;
212 size_t dot = fname.find_last_of(
".");
214 if (extension ==
"xml") {
216 "Restoring from XML is no longer supported.");
219 if (extension ==
"h5" || extension ==
"hdf" || extension ==
"hdf5") {
220 map<string, shared_ptr<SolutionArray>> arrs;
223 for (
auto dom :
m_dom) {
226 arr->readEntry(fname, name, dom->id());
229 "Encountered exception when reading entry '{}' from '{}':\n{}",
232 dom->resize(dom->nComponents(), arr->size());
233 if (!header.
hasKey(
"generator")) {
234 arr->meta() = legacyH5(arr, header);
236 arrs[dom->id()] = arr;
240 for (
auto dom :
m_dom) {
242 dom->fromArray(arrs[dom->id()]);
245 "Encountered exception when restoring domain '{}' from HDF:\n{}",
250 }
else if (extension ==
"yaml" || extension ==
"yml") {
252 map<string, shared_ptr<SolutionArray>> arrs;
255 for (
auto dom :
m_dom) {
258 arr->readEntry(root, name, dom->id());
261 "Encountered exception when reading entry '{}' from '{}':\n{}",
264 dom->resize(dom->nComponents(), arr->size());
265 arrs[dom->id()] = arr;
269 for (
auto dom :
m_dom) {
271 dom->fromArray(arrs[dom->id()]);
274 "Encountered exception when restoring domain '{}' from YAML:\n{}",
281 "Unknown file extension '{}'; supported extensions include "
282 "'h5'/'hdf'/'hdf5' and 'yml'/'yaml'.", extension);
294 for (
size_t n = 0; n <
nDomains(); n++) {
297 +
" <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n\n");
307 throw CanteraError(
"Sim1D::restoreTimeSteppingSolution",
308 "No successful time steps taken on this grid.");
317 "No successful steady state solution");
320 for (
size_t n = 0; n <
nDomains(); n++) {
328 for (
size_t n = 0; n <
nDomains(); n++) {
336 for (
size_t n = 0; n <
nDomains(); n++) {
351 while (new_points > 0) {
354 writelog(
"\nNewton steady-state solve succeeded.\n\n");
356 for (
size_t mm = 1; mm <
nDomains(); mm+=2) {
371 new_points =
refine(loglevel);
375 debuglog(
"grid refinement disabled.\n", loglevel);
379 if (new_points < 0) {
383 for (
auto dom :
m_dom) {
384 span<const double> x(
m_state->data() + dom->loc(), dom->size());
385 span<double> r(
m_xnew.data() + dom->loc(), dom->size());
386 span<int> mask(
m_mask.data() + dom->loc(), dom->size());
387 dom->eval(
npos, x, r, mask);
396 vector<double> znew, xnew;
397 vector<size_t> dsize;
402 for (
size_t n = 0; n <
nDomains(); n++) {
407 auto grid = d.
grid();
423 size_t nstart = znew.size();
424 for (
size_t m = 0; m < npnow; m++) {
427 znew.push_back(d.
z(m));
430 for (
size_t i = 0; i < comp; i++) {
431 xnew.push_back(
_value(n, i, m));
439 double zmid = 0.5*(d.
z(m) + d.
z(m+1));
440 znew.push_back(zmid);
445 for (
size_t i = 0; i < comp; i++) {
446 double xmid = 0.5*(
_value(n, i, m) +
_value(n, i, m+1));
447 xnew.push_back(xmid);
453 writelog(
"refine: discarding point at {}\n", d.
z(m));
457 dsize.push_back(znew.size() - nstart);
464 size_t gridstart = 0, gridsize;
465 for (
size_t n = 0; n <
nDomains(); n++) {
469 d.
setupGrid(span<const double>(znew.data() + gridstart, gridsize));
471 gridstart += gridsize;
478 return added || -discarded;
483 std::filesystem::remove(
"debug_sim1d.yaml");
487 int loglevel,
int attempt_counter)
491 file_header = fmt::format(
"solution_{}_{}", attempt_counter, header_suffix);
492 save(
"debug_sim1d.yaml", file_header, message,
true);
495 file_header = fmt::format(
"residual_{}_{}", attempt_counter, header_suffix);
496 saveResidual(
"debug_sim1d.yaml", file_header, message,
true);
503 vector<double> znew, xnew;
505 double z1 = 0.0, z2 = 0.0;
506 vector<size_t> dsize;
508 for (
size_t n = 0; n <
nDomains(); n++) {
511 size_t mfixed =
npos;
516 size_t nstart = znew.size();
517 if (d_free && d_free->
isFree()) {
518 for (
size_t m = 0; m < npnow - 1; m++) {
519 bool fixedpt =
false;
523 double thresh = min(1., 1.e-1 * (t2 - t1));
526 if (fabs(t - t1) <= thresh) {
529 }
else if (fabs(t2 - t) <= thresh) {
532 }
else if ((t1 < t) && (t < t2)) {
534 zfixed = (z1 - z2) / (t1 - t2) * (t - t2) + z2;
547 for (
size_t m = 0; m < npnow; m++) {
549 znew.push_back(d.
z(m));
552 for (
size_t i = 0; i < comp; i++) {
553 xnew.push_back(
_value(n, i, m));
557 znew.push_back(zfixed);
559 double interp_factor = (zfixed - z2) / (z1 - z2);
562 for (
size_t i = 0; i < comp; i++) {
563 double xmid = interp_factor*(
565 xnew.push_back(xmid);
569 dsize.push_back(znew.size() - nstart);
575 size_t gridstart = 0;
576 for (
size_t n = 0; n <
nDomains(); n++) {
578 size_t gridsize = dsize[n];
579 d.
setupGrid(span<const double>(znew.data() + gridstart, gridsize));
580 gridstart += gridsize;
593 double t_fixed = std::numeric_limits<double>::quiet_NaN();
594 for (
size_t n = 0; n <
nDomains(); n++) {
606 double z_fixed = std::numeric_limits<double>::quiet_NaN();
607 for (
size_t n = 0; n <
nDomains(); n++) {
619 bool two_point_domain_found =
false;
620 for (
size_t n = 0; n <
nDomains(); n++) {
635 two_point_domain_found =
true;
637 double current_val, next_val;
638 for (
size_t m = 0; m < np-1; m++) {
641 if ((current_val - temperature) * (next_val - temperature) < 0.0) {
645 if (std::abs(current_val - temperature) <
646 std::abs(next_val - temperature)) {
658 if (!two_point_domain_found) {
660 "No domain with two-point control enabled was found.");
663 "No control point with temperature {} was able to be found in the"
664 "flame's temperature range.", temperature);
670 bool two_point_domain_found =
false;
671 for (
size_t n = 0; n <
nDomains(); n++) {
686 two_point_domain_found =
true;
688 double current_val, next_val;
689 for (
size_t m = np-1; m > 0; m--) {
692 if ((current_val - temperature) * (next_val - temperature) < 0.0) {
696 if (std::abs(current_val - temperature) <
697 std::abs(next_val - temperature)) {
709 if (!two_point_domain_found) {
711 "No domain with two-point control enabled was found.");
714 "No control point with temperature {} was able to be found in the"
715 "flame's temperature range.", temperature);
721 double slope,
double curve,
double prune)
726 for (
size_t n = 0; n <
nDomains(); n++) {
738 "Must specify domain to get criteria from");
748 for (
size_t n = 0; n <
nDomains(); n++) {
761 for (
size_t n = 0; n <
nDomains(); n++) {
781 for (
auto& D :
m_dom) {
782 D->forceFullUpdate(
true);
785 for (
auto& D :
m_dom) {
786 D->forceFullUpdate(
false);
789 auto multijac = dynamic_pointer_cast<MultiJac>(
m_jac);
791 throw CanteraError(
"Sim1D::solveAdjoint",
"Banded (MultiJac) required");
796 for (
size_t i = 0; i <
size(); i++) {
797 size_t j1 = (i > bw) ? i - bw : 0;
798 size_t j2 = (i + bw >=
size()) ?
size() - 1: i + bw;
799 for (
size_t j = j1; j <= j2; j++) {
800 Jt(j,i) = multijac->
value(i,j);
813shared_ptr<Sim1D>
newSim1D(vector<shared_ptr<Domain1D>>& domains)
815 return make_shared<Sim1D>(domains);
A map of string keys to values whose type can vary at runtime.
double getDouble(const string &key, double default_) const
If key exists, return it as a double, otherwise return default_.
bool hasKey(const string &key) const
Returns true if the map contains an item named key.
static void clearCachedFile(const string &filename)
Remove the specified file from the input cache if it is present.
static AnyMap fromYamlFile(const string &name, const string &parent_name="")
Create an AnyMap from a YAML file.
A class for banded matrices, involving matrix inversion processes.
void solve(span< const double > b, span< double > x)
Solve the matrix problem Ax = b.
double & value(size_t i, size_t j)
Return a changeable reference to element (i,j).
Base class for exceptions thrown by Cantera classes.
virtual string getMessage() const
Method overridden by derived classes to format the error message.
Base class for one-dimensional domains.
virtual void _getInitialSoln(span< double > x)
Writes some or all initial solution values into the global solution array, beginning at the location ...
virtual void setupGrid(span< const double > z)
Set up initial grid.
size_t nComponents() const
Number of components at each grid point.
size_t size() const
Return the size of the solution vector (the product of m_nv and m_points).
span< double > grid()
Access the array of grid coordinates [m].
size_t nPoints() const
Number of grid points in this domain.
virtual string domainType() const
Domain type flag.
double z(size_t jlocal) const
Get the coordinate [m] of the point with local index jlocal
Refiner & refiner()
Return a reference to the grid refiner.
virtual void show(span< const double > x)
Print the solution.
size_t index(size_t n, size_t j) const
Returns the index of the solution vector, which corresponds to component n at grid point j.
vector< double > getRefineCriteria()
Get the grid refinement criteria.
virtual size_t loc(size_t j=0) const
Location of the start of the local solution vector in the global solution vector.
virtual void _finalize(span< const double > x)
In some cases, a domain may need to set parameters that depend on the initial solution estimate.
void setRefineCriteria(double ratio=10.0, double slope=0.8, double curve=0.8, double prune=-0.1)
Set grid refinement criteria.
This class represents 1D flow domains that satisfy the one-dimensional similarity solution for chemic...
void setLeftControlPointTemperature(double temperature)
Sets the temperature of the left control point.
void setLeftControlPointCoordinate(double z_left)
Sets the coordinate of the left control point.
void setRightControlPointCoordinate(double z_right)
Sets the coordinate of the right control point.
bool twoPointControlEnabled() const
Returns the status of the two-point control.
void setRightControlPointTemperature(double temperature)
Sets the temperature of the right control point.
double m_tfixed
Temperature at the point used to fix the flame location.
double m_zfixed
Location of the point where temperature is fixed.
bool isFree() const
Retrieve flag indicating whether flow is freely propagating.
virtual double eval(double t) const
Evaluate the function.
Container class for multiple-domain 1D problems.
size_t start(size_t i) const
The index of the start of domain i in the solution vector.
void resize() override
Call to set the size of internal data structures after first defining the system or if the problem si...
size_t nDomains() const
Number of domains.
Domain1D & domain(size_t i) const
Return a reference to domain i.
vector< shared_ptr< Domain1D > > m_dom
All domains comprising the system.
void eval(size_t j, span< const double > x, span< double > r, double rdt=-1.0, int count=1)
Evaluate the multi-domain residual function.
Refine Domain1D grids so that profiles satisfy adaptation tolerances.
bool newPointNeeded(size_t j)
Returns true if a new grid point is needed to the right of grid index j.
size_t maxPoints() const
Returns the maximum number of points allowed in the domain.
int nNewPoints()
Returns the number of new grid points that were needed.
void show()
Displays the results of the grid refinement analysis.
void setMaxPoints(int npmax)
Set the maximum number of points allowed in the domain.
int analyze(size_t n, span< const double > z, span< const double > x)
Determine locations in the grid that need additional grid points and update the internal state of the...
bool keepPoint(size_t j)
Returns true if the grid point at index j should be kept.
void setGridMin(double gridmin)
Set the minimum allowable spacing between adjacent grid points [m].
void getInitialSoln()
Get the initial value of the system state from each domain in the simulation.
void restoreTimeSteppingSolution()
Set the current solution vector to the last successful time-stepping solution.
void resize() override
Call to set the size of internal data structures after first defining the system or if the problem si...
void saveResidual(const string &fname, const string &name, const string &desc, bool overwrite=false, int compression=0)
Save the residual of the current solution to a container file.
double fixedTemperatureLocation()
Return location of the point where temperature is fixed.
vector< vector< double > > m_grid_last_ss
the grids for each domain after the last successful steady-state solve (stored before grid refinement...
double _value(size_t dom, size_t comp, size_t localPoint) const
Get one entry in the solution vector.
void finalize()
Calls method _finalize in each domain.
int refine(int loglevel=0)
Refine the grid in all domains.
void show()
Show logging information on current solution for all domains.
double fixedTemperature()
Return temperature at the point used to fix the flame location.
void clearDebugFile() override
Deletes a debug_sim1d.yaml file if it exists.
double _workValue(size_t dom, size_t comp, size_t localPoint) const
Get an entry in the work vector, which may contain either a new system state or the current residual ...
vector< double > m_xlast_ss
the solution vector after the last successful steady-state solve (stored before grid refinement)
void _restore(const string &fname, const string &name)
Retrieve data from a previously saved simulation.
void setMaxGridPoints(int dom, int npoints)
Set the maximum number of grid points in the domain.
int setFixedTemperature(double t)
Add node for fixed temperature point of freely propagating flame.
void solve(int loglevel=0, bool refine_grid=true)
Performs the hybrid Newton steady/time-stepping solution.
void evalSSJacobian()
Evaluate the Jacobian in steady-state mode.
AnyMap restore(const string &fname, const string &name)
Retrieve data and settings from a previously saved simulation.
Func1 * m_steady_callback
User-supplied function called after a successful steady-state solve.
void solveAdjoint(span< const double > b, span< double > lambda)
Solve the equation .
void restoreSteadySolution()
Set the current solution vector and grid to the last successful steady- state solution.
size_t maxGridPoints(size_t dom)
Get the maximum number of grid points in this domain.
void writeDebugInfo(const string &header_suffix, const string &message, int loglevel, int attempt_counter) override
Write solver debugging information to a YAML file based on the specified log level.
void setRightControlPoint(double temperature)
Set the right control point location using the specified temperature.
vector< double > getRefineCriteria(int dom)
Get the grid refinement criteria.
Sim1D()
Default constructor.
void setGridMin(int dom, double gridmin)
Set the minimum grid spacing in the specified domain(s).
void setRefineCriteria(int dom=-1, double ratio=10.0, double slope=0.8, double curve=0.8, double prune=-0.1)
Set grid refinement criteria.
void _setValue(size_t dom, size_t comp, size_t localPoint, double value)
Set a single value in the solution vector.
void save(const string &fname, const string &name, const string &desc, bool overwrite=false, int compression=0, const string &basis="")
Save current simulation data to a container file or CSV format.
void setLeftControlPoint(double temperature)
Set the left control point location using the specified temperature.
static AnyMap readHeader(const string &fname, const string &name)
Read header information from a HDF container file.
static void writeHeader(const string &fname, const string &name, const string &desc, bool overwrite=false)
Write header data to a HDF container file.
static shared_ptr< SolutionArray > create(const shared_ptr< Solution > &sol, int size=0, const AnyMap &meta={})
Instantiate a new SolutionArray reference.
vector< double > m_xnew
Work array used to hold the residual or the new solution.
size_t size() const
Total solution vector length;.
void evalSSJacobian(span< const double > x)
Evaluate the steady-state Jacobian, accessible via linearSolver()
size_t bandwidth() const
Jacobian bandwidth.
shared_ptr< SystemJacobian > m_jac
Jacobian evaluator.
shared_ptr< vector< double > > m_state
Solution vector.
vector< int > m_mask
Transient mask.
void solve(int loglevel=0)
Solve the steady-state problem, taking internal timesteps as necessary until the Newton solver can co...
int m_attempt_counter
Counter used to manage the number of states stored in the debug log file generated by writeDebugInfo(...
vector< double > m_xlast_ts
State vector after the last successful set of time steps.
Header for a file containing miscellaneous numerical functions.
string toLowerCopy(const string &input)
Convert to lower case.
#define AssertThrowMsg(expr, procedure,...)
Assertion must be true or an error is thrown.
void debuglog(const string &msg, int loglevel)
Write a message to the log only if loglevel > 0.
void writelog(const string &fmt, const Args &... args)
Write a formatted message to the screen.
double dot(InputIter x_begin, InputIter x_end, InputIter2 y_begin)
Function that calculates a templated inner product.
void warn_user(const string &method, const string &msg, const Args &... args)
Print a user warning raised from method as CanteraWarning.
Namespace for the Cantera kernel.
const size_t npos
index returned by functions to indicate "no position"
shared_ptr< Sim1D > newSim1D(vector< shared_ptr< Domain1D > > &domains)
Create a Sim1D object with a list of domains.
@ c_offset_T
temperature [kelvin]
Contains declarations for string manipulation functions within Cantera.