Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update C++ SolutionArray interface to use 'int' #1520

Merged
merged 4 commits into from Jun 29, 2023
Merged

Update C++ SolutionArray interface to use 'int' #1520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc92fca
[base] Use 'int' for SolutionArray API
ischoegl Jun 29, 2023
745217c
[clib] Fix MSVC compiler warnings
ischoegl Jun 29, 2023
c6b24c1
[Python] Update SolutionArray pxd information
ischoegl Jun 29, 2023
bde12f2
Update yaml-cpp submodule to v0.7.0
speth Jun 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion ext/yaml-cpp
Open in desktop
Submodule yaml-cpp updated 492 files
22 changes: 11 additions & 11 deletions include/cantera/base/SolutionArray.h
View file
Open in desktop
Expand Up @@ -27,7 +27,7 @@ class SolutionArray
{
private:
SolutionArray(const shared_ptr<Solution>& sol,
size_t size,
int size,
const AnyMap& meta);

SolutionArray(const SolutionArray& arr, const vector<int>& indices);
Expand All @@ -43,7 +43,7 @@ class SolutionArray
* @param meta AnyMap holding SolutionArray meta data
*/
static shared_ptr<SolutionArray> create(const shared_ptr<Solution>& sol,
size_t size=0,
int size=0,
const AnyMap& meta={})
{
return shared_ptr<SolutionArray>(new SolutionArray(sol, size, meta));
Expand All @@ -70,7 +70,7 @@ class SolutionArray
}

//! Resize SolutionArray objects with a single dimension (default).
void resize(size_t size);
void resize(int size);

//! SolutionArray shape information used by high-level API's.
vector<long int> apiShape() const {
Expand All @@ -82,8 +82,8 @@ class SolutionArray
void setApiShape(const vector<long int>& shape);

//! Number of SolutionArray dimensions used by high-level API's.
size_t apiNdim() const {
return m_apiShape.size();
int apiNdim() const {
return static_cast<int>(m_apiShape.size());
}

/*!
Expand Down Expand Up @@ -142,18 +142,18 @@ class SolutionArray
/*!
* Update the buffered location used to access SolutionArray entries.
*/
void setLoc(size_t loc, bool restore=true);
void setLoc(int loc, bool restore=true);

/*!
* Update state at given location to state of associated Solution object.
*/
void updateState(size_t loc);
void updateState(int loc);

//! Retrieve the state vector for a given location.
vector<double> getState(size_t loc);
vector<double> getState(int loc);

//! Set the state vector for a given location.
void setState(size_t loc, const vector<double>& state);
void setState(int loc, const vector<double>& state);

//! Normalize mass/mole fractions
void normalize();
Expand All @@ -178,10 +178,10 @@ class SolutionArray
vector<string> listExtra(bool all=true) const;

//! Retrieve auxiliary data for a given location.
AnyMap getAuxiliary(size_t loc);
AnyMap getAuxiliary(int loc);

//! Set auxiliary data for a given location.
void setAuxiliary(size_t loc, const AnyMap& data);
void setAuxiliary(int loc, const AnyMap& data);

//! Append location entry at end of SolutionArray.
void append(const vector<double>& state, const AnyMap& extra);
Expand Down
20 changes: 10 additions & 10 deletions interfaces/cython/cantera/solutionbase.pxd
View file
Open in desktop
Expand Up @@ -67,33 +67,33 @@ cdef extern from "cantera/base/SolutionArray.h" namespace "Cantera":
cdef cppclass CxxSolutionArray "Cantera::SolutionArray":
shared_ptr[CxxSolutionArray] share(vector[int]&) except +translate_exception
void reset() except +translate_exception
size_t size()
void resize(size_t) except +translate_exception
int size()
void resize(int) except +translate_exception
vector[long int] apiShape() except +translate_exception
void setApiShape(vector[long int]&) except +translate_exception
size_t apiNdim()
int apiNdim()
string info(vector[string]&, int, int) except +translate_exception
CxxAnyMap meta()
void setMeta(CxxAnyMap&)
vector[string] componentNames() except +translate_exception
cbool hasComponent(string&)
CxxAnyValue getComponent(string&) except +translate_exception
void setComponent(string&, CxxAnyValue&) except +translate_exception
void setLoc(size_t) except +translate_exception
void updateState(size_t) except +translate_exception
vector[double] getState(size_t) except +translate_exception
void setState(size_t, vector[double]&) except +translate_exception
void setLoc(int) except +translate_exception
void updateState(int) except +translate_exception
vector[double] getState(int) except +translate_exception
void setState(int, vector[double]&) except +translate_exception
vector[string] listExtra()
cbool hasExtra(string&)
void addExtra(string&, cbool) except +translate_exception
CxxAnyMap getAuxiliary(size_t) except +translate_exception
void setAuxiliary(size_t, CxxAnyMap&) except +translate_exception
CxxAnyMap getAuxiliary(int) except +translate_exception
void setAuxiliary(int, CxxAnyMap&) except +translate_exception
void append(vector[double]&, CxxAnyMap&) except +translate_exception
void save(string&, string&, string&, string&, cbool, int, string&) except +translate_exception
CxxAnyMap restore(string&, string&, string&) except +translate_exception

cdef shared_ptr[CxxSolutionArray] CxxNewSolutionArray "Cantera::SolutionArray::create" (
shared_ptr[CxxSolution], size_t, CxxAnyMap&) except +translate_exception
shared_ptr[CxxSolution], int, CxxAnyMap&) except +translate_exception


ctypedef void (*transportMethod1d)(CxxTransport*, double*) except +translate_exception
Expand Down
77 changes: 41 additions & 36 deletions src/base/SolutionArray.cpp
View file
Open in desktop
Expand Up @@ -37,7 +37,7 @@ namespace Cantera
{

SolutionArray::SolutionArray(const shared_ptr<Solution>& sol,
size_t size, const AnyMap& meta)
int size, const AnyMap& meta)
: m_sol(sol)
, m_size(size)
, m_dataSize(size)
Expand All @@ -52,11 +52,11 @@ SolutionArray::SolutionArray(const shared_ptr<Solution>& sol,
m_extra = make_shared<map<string, AnyValue>>();
m_order = make_shared<map<int, string>>();
for (size_t i = 0; i < m_dataSize; ++i) {
m_active.push_back(i);
m_active.push_back(static_cast<int>(i));
}
reset();
m_apiShape.resize(1);
m_apiShape[0] = m_dataSize;
m_apiShape[0] = static_cast<long>(m_dataSize);
}

SolutionArray::SolutionArray(const SolutionArray& other,
Expand Down Expand Up @@ -150,7 +150,7 @@ void SolutionArray::reset()
}
}

void SolutionArray::resize(size_t size)
void SolutionArray::resize(int size)
{
if (apiNdim() > 1) {
throw CanteraError("SolutionArray::resize",
Expand All @@ -161,8 +161,8 @@ void SolutionArray::resize(size_t size)
throw CanteraError("SolutionArray::resize",
"Unable to resize as data are shared by multiple objects.");
}
_resize(size);
m_apiShape[0] = size;
_resize(static_cast<size_t>(size));
m_apiShape[0] = static_cast<long>(size);
}

void SolutionArray::setApiShape(const vector<long int>& shape)
Expand Down Expand Up @@ -196,7 +196,7 @@ void SolutionArray::_resize(size_t size)
}
m_active.clear();
for (size_t i = 0; i < m_dataSize; ++i) {
m_active.push_back(i);
m_active.push_back(static_cast<int>(i));
}
}

Expand All @@ -209,8 +209,9 @@ vector<string> doubleColumn(string name, const vector<double>& comp,
vector<double> data;
vector<string> raw;
string notation = fmt::format("{{:{}.{}g}}", width, (width - 1) / 2);
int dots = comp.size() + 1;
if (comp.size() <= rows) {
int csize = static_cast<int>(comp.size());
int dots = csize + 1;
if (csize <= rows) {
for (const auto& val : comp) {
data.push_back(val);
raw.push_back(boost::trim_copy(fmt::format(notation, val)));
Expand All @@ -221,7 +222,7 @@ vector<string> doubleColumn(string name, const vector<double>& comp,
data.push_back(comp[row]);
raw.push_back(boost::trim_copy(fmt::format(notation, comp[row])));
}
for (int row = comp.size() - rows / 2; row < comp.size(); row++) {
for (int row = csize - rows / 2; row < csize; row++) {
data.push_back(comp[row]);
raw.push_back(boost::trim_copy(fmt::format(notation, comp[row])));
}
Expand Down Expand Up @@ -296,8 +297,9 @@ vector<string> integerColumn(string name, const vector<long int>& comp,
vector<double> data;
string notation = fmt::format("{{:{}}}", width);
size_t maxLen = 2; // minimum column width is 2
int dots = comp.size() + 1;
if (comp.size() <= rows) {
int csize = static_cast<int>(comp.size());
int dots = csize + 1;
if (csize <= rows) {
for (const auto& val : comp) {
data.push_back(val);
string name = boost::trim_copy(fmt::format(notation, val));
Expand All @@ -316,7 +318,7 @@ vector<string> integerColumn(string name, const vector<long int>& comp,
}
maxLen = std::max(maxLen, name.size());
}
for (int row = comp.size() - rows / 2; row < comp.size(); row++) {
for (int row = csize - rows / 2; row < csize; row++) {
data.push_back(comp[row]);
string name = boost::trim_copy(fmt::format(notation, comp[row]));
if (name[0] == '-') {
Expand Down Expand Up @@ -355,8 +357,9 @@ vector<string> stringColumn(string name, const vector<string>& comp,
vector<string> data;
string notation = fmt::format("{{:{}}}", width);
size_t maxLen = 3; // minimum column width is 3
int dots = comp.size() + 1;
if (comp.size() <= rows) {
int csize = static_cast<int>(comp.size());
int dots = csize + 1;
if (csize <= rows) {
for (const auto& val : comp) {
data.push_back(val);
maxLen = std::max(maxLen,
Expand All @@ -369,7 +372,7 @@ vector<string> stringColumn(string name, const vector<string>& comp,
maxLen = std::max(maxLen,
boost::trim_copy(fmt::format(notation, comp[row])).size());
}
for (int row = comp.size() - rows / 2; row < comp.size(); row++) {
for (int row = csize - rows / 2; row < csize; row++) {
data.push_back(comp[row]);
maxLen = std::max(maxLen,
boost::trim_copy(fmt::format(notation, comp[row])).size());
Expand Down Expand Up @@ -434,7 +437,8 @@ vector<string> formatColumn(string name, const AnyValue& comp, int rows, int wid
col.push_back(repr);
}
col.push_back(fmt::format(notation, "..."));
for (int row = size - rows / 2; row < size; row++) {
int size_ = static_cast<int>(size);
for (int row = size_ - rows / 2; row < size_; row++) {
col.push_back(repr);
}
}
Expand Down Expand Up @@ -732,37 +736,38 @@ void SolutionArray::setComponent(const string& name, const AnyValue& data)
}
}

void SolutionArray::setLoc(size_t loc, bool restore)
void SolutionArray::setLoc(int loc, bool restore)
{
size_t loc_ = static_cast<size_t>(loc);
if (m_size == 0) {
throw CanteraError("SolutionArray::setLoc",
"Unable to set location in empty SolutionArray.");
} else if (loc == npos) {
} else if (loc < 0) {
if (m_loc == npos) {
throw CanteraError("SolutionArray::setLoc",
"Both current and buffered indices are invalid.");
}
return;
} else if (m_active[loc] == (int)m_loc) {
} else if (m_active[loc_] == m_loc) {
return;
} else if (loc >= m_size) {
throw IndexError("SolutionArray::setLoc", "indices", loc, m_size - 1);
} else if (loc_ >= m_size) {
throw IndexError("SolutionArray::setLoc", "indices", loc_, m_size - 1);
}
m_loc = m_active[loc];
m_loc = m_active[loc_];
if (restore) {
size_t nState = m_sol->thermo()->stateSize();
m_sol->thermo()->restoreState(nState, m_data->data() + m_loc * m_stride);
}
}

void SolutionArray::updateState(size_t loc)
void SolutionArray::updateState(int loc)
{
setLoc(loc, false);
size_t nState = m_sol->thermo()->stateSize();
m_sol->thermo()->saveState(nState, m_data->data() + m_loc * m_stride);
}

vector<double> SolutionArray::getState(size_t loc)
vector<double> SolutionArray::getState(int loc)
{
setLoc(loc);
size_t nState = m_sol->thermo()->stateSize();
Expand All @@ -771,7 +776,7 @@ vector<double> SolutionArray::getState(size_t loc)
return out;
}

void SolutionArray::setState(size_t loc, const vector<double>& state)
void SolutionArray::setState(int loc, const vector<double>& state)
{
size_t nState = m_sol->thermo()->stateSize();
if (state.size() != nState) {
Expand All @@ -794,15 +799,15 @@ void SolutionArray::normalize() {
vector<double> out(nState);
if (nativeState.count("Y")) {
size_t offset = nativeState["Y"];
for (size_t loc = 0; loc < m_size; loc++) {
for (int loc = 0; loc < static_cast<int>(m_size); loc++) {
setLoc(loc, true); // set location and restore state
phase->setMassFractions(m_data->data() + m_loc * m_stride + offset);
m_sol->thermo()->saveState(out);
setState(loc, out);
}
} else if (nativeState.count("X")) {
size_t offset = nativeState["X"];
for (size_t loc = 0; loc < m_size; loc++) {
for (int loc = 0; loc < static_cast<int>(m_size); loc++) {
setLoc(loc, true); // set location and restore state
phase->setMoleFractions(m_data->data() + m_loc * m_stride + offset);
m_sol->thermo()->saveState(out);
Expand All @@ -814,7 +819,7 @@ void SolutionArray::normalize() {
}
}

AnyMap SolutionArray::getAuxiliary(size_t loc)
AnyMap SolutionArray::getAuxiliary(int loc)
{
setLoc(loc);
AnyMap out;
Expand Down Expand Up @@ -842,7 +847,7 @@ AnyMap SolutionArray::getAuxiliary(size_t loc)
return out;
}

void SolutionArray::setAuxiliary(size_t loc, const AnyMap& data)
void SolutionArray::setAuxiliary(int loc, const AnyMap& data)
{
setLoc(loc, false);
for (const auto& [name, value] : data) {
Expand Down Expand Up @@ -1051,7 +1056,7 @@ void SolutionArray::writeEntry(const string& fname, bool overwrite, const string
output << header.str() << std::endl << std::setprecision(9);

vector<double> buf(speciesNames.size(), 0.);
for (size_t row = 0; row < m_size; row++) {
for (int row = 0; row < static_cast<int>(m_size); row++) {
setLoc(row);
if (mole) {
m_sol->thermo()->getMoleFractions(buf.data());
Expand Down Expand Up @@ -1254,7 +1259,7 @@ void SolutionArray::append(const vector<double>& state, const AnyMap& extra)
"Unable to append multi-dimensional arrays.");
}

size_t pos = size();
int pos = size();
resize(pos + 1);
try {
setState(pos, state);
Expand Down Expand Up @@ -1643,7 +1648,7 @@ void SolutionArray::readEntry(const string& fname, const string& name,
m_meta.erase("api-shape");
} else {
// legacy format; size needs to be detected
resize(size);
resize(static_cast<int>(size));
}

if (m_size == 0) {
Expand Down Expand Up @@ -1793,7 +1798,7 @@ void SolutionArray::readEntry(const AnyMap& root, const string& name, const stri
}

// set size and initialize
size_t size = 0;
long size = 0;
if (path.hasKey("size")) {
// one-dimensional array
resize(path["size"].asInt());
Expand All @@ -1806,9 +1811,9 @@ void SolutionArray::readEntry(const AnyMap& root, const string& name, const stri
size = path.getInt("points", 0);
if (!path.hasKey("T") && !path.hasKey("temperature")) {
// overwrite size - Sim1D erroneously assigns '1'
size = 0;
size = (long)0;
}
resize(size);
resize(static_cast<int>(size));
}
m_extra->clear();

Expand Down