SolutionArray.h Source File#
SolutionArray.h
Go to the documentation of this file.
A map of string keys to values whose type can vary at runtime.
Definition AnyMap.h:427
A wrapper for a variable whose type is determined at runtime.
Definition AnyMap.h:86
A container class holding arrays of state information.
Definition SolutionArray.h:33
void append(const vector< double > &state, const AnyMap &extra)
Append location entry at end of SolutionArray.
Definition SolutionArray.cpp:1258
void setLoc(int loc, bool restore=true)
Update the buffered location used to access SolutionArray entries.
Definition SolutionArray.cpp:739
string _detectMode(const set< string > &names, bool native=true)
Identify storage mode of state data.
Definition SolutionArray.cpp:1534
static AnyMap readHeader(const string &fname, const string &name)
Read header information from a HDF container file.
Definition SolutionArray.cpp:1323
shared_ptr< SolutionArray > share(const vector< int > &selected)
Share locations from an existing SolutionArray and return new reference.
Definition SolutionArray.h:65
void _setExtra(const string &name, const AnyValue &data=AnyValue())
Set extra SolutionArray component.
Definition SolutionArray.cpp:1468
string info(const vector< string > &keys, int rows=10, int width=80)
Print a concise summary of a SolutionArray.
Definition SolutionArray.cpp:450
vector< string > listExtra(bool all=true) const
Retrieve list of extra component names.
Definition SolutionArray.cpp:598
void setApiShape(const vector< long int > &shape)
Set SolutionArray shape information used by high-level API's.
Definition SolutionArray.cpp:169
void setAuxiliary(int loc, const AnyMap &data)
Set auxiliary data for a given location.
Definition SolutionArray.cpp:850
static void writeHeader(const string &fname, const string &name, const string &desc, bool overwrite=false)
Write header data to a HDF container file.
Definition SolutionArray.cpp:949
AnyMap restore(const string &fname, const string &name, const string &sub="")
Restore SolutionArray data and header information from a container file.
Definition SolutionArray.cpp:1365
AnyMap getAuxiliary(int loc)
Retrieve auxiliary data for a given location.
Definition SolutionArray.cpp:822
AnyValue getComponent(const string &name) const
Retrieve a component of the SolutionArray by name.
Definition SolutionArray.cpp:640
set< string > _stateProperties(const string &mode, bool alias=false)
Retrieve set containing list of properties defining state.
Definition SolutionArray.cpp:1592
void readEntry(const string &fname, const string &name, const string &sub)
Restore SolutionArray data from a HDF container file.
Definition SolutionArray.cpp:1622
void _resize(size_t size)
Service function used to resize SolutionArray.
Definition SolutionArray.cpp:190
bool hasComponent(const string &name) const
Check whether SolutionArray contains a component.
Definition SolutionArray.cpp:622
void _initExtra(const string &name, const AnyValue &value)
Initialize extra SolutionArray component.
Definition SolutionArray.cpp:1391
vector< string > componentNames() const
Retrieve list of component names.
Definition SolutionArray.cpp:539
vector< long int > apiShape() const
SolutionArray shape information used by high-level API's.
Definition SolutionArray.h:82
shared_ptr< map< string, AnyValue > > m_extra
Auxiliary (extra) components; size of first dimension has to match m_dataSize.
Definition SolutionArray.h:391
void setState(int loc, const vector< double > &state)
Set the state vector for a given location.
Definition SolutionArray.cpp:779
shared_ptr< map< int, string > > m_order
Mapping of auxiliary component names, where the index is used as the mapping key.
Definition SolutionArray.h:397
int apiNdim() const
Number of SolutionArray dimensions used by high-level API's.
Definition SolutionArray.h:91
void setComponent(const string &name, const AnyValue &data)
Set a component of the SolutionArray by name.
Definition SolutionArray.cpp:704
void save(const string &fname, const string &name="", const string &sub="", const string &desc="", bool overwrite=false, int compression=0, const string &basis="")
Save current SolutionArray contents to a data file.
Definition SolutionArray.cpp:1277
void reset()
Reset all entries of the SolutionArray to the current Solution state.
Definition SolutionArray.cpp:123
void resize(int size)
Resize SolutionArray objects with a single dimension (default).
Definition SolutionArray.cpp:154
void _resizeExtra(const string &name, const AnyValue &value=AnyValue())
Resize extra SolutionArray component.
Definition SolutionArray.cpp:1431
shared_ptr< ThermoPhase > thermo()
Retrieve associated ThermoPhase object.
Definition SolutionArray.cpp:534
void addExtra(const string &name, bool back=true)
Add auxiliary component to SolutionArray.
Definition SolutionArray.cpp:572
bool hasExtra(const string &name) const
Check whether SolutionArray contains an extra component.
Definition SolutionArray.h:181
void updateState(int loc)
Update state at given location to state of associated Solution object.
Definition SolutionArray.cpp:763
static shared_ptr< SolutionArray > create(const shared_ptr< Solution > &sol, int size=0, const AnyMap &meta={})
Instantiate a new SolutionArray reference.
Definition SolutionArray.h:51
vector< double > getState(int loc)
Retrieve the state vector for a given location.
Definition SolutionArray.cpp:770
void writeEntry(const string &fname, bool overwrite=false, const string &basis="")
Write SolutionArray data to a CSV file.
Definition SolutionArray.cpp:975
vector< long int > m_apiShape
Shape information used by high-level API's.
Definition SolutionArray.h:386
shared_ptr< Solution > m_sol
Solution object associated with state data.
Definition SolutionArray.h:380
This file contains definitions for utility functions and text for modules, inputfiles and logging,...
Generated by