Ioex::BaseDatabaseIO Class Reference

#include <Ioex_BaseDatabaseIO.h>

Inheritance diagram for Ioex::BaseDatabaseIO:

Collaboration diagram for Ioex::BaseDatabaseIO:

Public Member Functions
	BaseDatabaseIO (Ioss::Region *region, const std::string &filename, Ioss::DatabaseUsage db_usage, Ioss_MPI_Comm communicator, const Ioss::PropertyManager &props)
	~BaseDatabaseIO () override
IOSS_NODISCARD std::string	get_format () const override
IOSS_NODISCARD unsigned	entity_field_support () const override
Public Member Functions inherited from Ioss::DatabaseIO
	DatabaseIO ()=delete
	DatabaseIO (const DatabaseIO &)=delete
	DatabaseIO (DatabaseIO &&)=delete
DatabaseIO &	operator= (const DatabaseIO &)=delete
DatabaseIO &	operator= (DatabaseIO &&)=delete
virtual	~DatabaseIO ()
IOSS_NODISCARD bool	ok (bool write_message=false, std::string *error_message=nullptr, int *bad_count=nullptr) const
	Check to see if database state is OK.
IOSS_NODISCARD bool	using_parallel_io () const
IOSS_NODISCARD int64_t	node_global_to_local (int64_t global, bool must_exist) const
	Get the local (process-specific) node number corresponding to a global node number.
IOSS_NODISCARD int64_t	element_global_to_local (int64_t global) const
virtual IOSS_NODISCARD bool	node_major () const
void	release_memory ()
virtual void	finalize_database () const
void	set_pfs_name (const std::string &name) const
IOSS_NODISCARD std::string	get_pfs_name () const
void	set_dw_name (const std::string &name) const
	this will be the name in BB namespace
IOSS_NODISCARD std::string	get_dw_name () const
IOSS_NODISCARD std::string	get_dw_path () const
	We call this ONLY after we assure that using_dw() is TRUE.
void	check_set_dw () const
IOSS_NODISCARD bool	using_dw () const
IOSS_NODISCARD std::string	get_filename () const
	Get the file name associated with the database.
IOSS_NODISCARD const std::string &	decoded_filename () const
	Get a file-per-processor filename associated with the database.
IOSS_NODISCARD bool	is_input () const
	Determine whether the database is an input database.
IOSS_NODISCARD Ioss::DatabaseUsage	usage () const
	Get the Ioss::DatabaseUsage type of the database.
virtual IOSS_NODISCARD bool	needs_shared_node_information () const
	Determine whether the database needs information about process ownership of nodes.
IOSS_NODISCARD Ioss::IfDatabaseExistsBehavior	open_create_behavior () const
void	set_region (Region *region)
void	open_dw (const std::string &filename) const
	If we are planning to use BB(aka Burst Buffer) service, we will call simple C API provided by Cray DataWarp module.
void	close_dw () const
	Function which invokes stageout from BB to Disk, prior to completion of final close.
void	openDatabase () const
void	closeDatabase () const
void	flush_database () const
bool	open_group (const std::string &group_name)
	If a database type supports groups and if the database contains groups, open the specified group.
bool	create_subgroup (const std::string &group_name)
	If a database type supports groups, create the specified group as a child of the current group.
bool	begin (Ioss::State state)
	Set the database to the given State.
bool	end (Ioss::State state)
	Return the database to STATE_CLOSED.
bool	begin_state (int state, double time)
bool	end_state (int state, double time)
void	read_meta_data ()
void	get_step_times ()
virtual IOSS_NODISCARD bool	internal_edges_available () const
virtual IOSS_NODISCARD bool	internal_faces_available () const
IOSS_NODISCARD const std::vector< std::string > &	get_information_records () const
	Get all information records (informative strings) for the database.
void	add_information_records (const std::vector< std::string > &info)
	Add multiple information records (informative strings) to the database.
void	add_information_record (const std::string &info)
	Add an information record (an informative string) to the database.
IOSS_NODISCARD const std::vector< std::string > &	get_qa_records () const
	Get all QA records, each of which consists of 4 strings, from the database.
void	add_qa_record (const std::string &code, const std::string &code_qa, const std::string &date, const std::string &time)
	Add a QA record, which consists of 4 strings, to the database.
IOSS_NODISCARD bool	get_logging () const
void	set_logging (bool on_off)
IOSS_NODISCARD bool	get_nan_detection () const
void	set_nan_detection (bool on_off)
template<typename T >
int64_t	get_field (const T *reg, const Field &field, void *data, size_t data_size) const
template<typename T >
int64_t	put_field (const T *reg, const Field &field, void *data, size_t data_size) const
template<typename T >
int64_t	get_zc_field (const T *reg, const Field &field, void **data, size_t *data_size) const
IOSS_NODISCARD bool	is_parallel_consistent () const
void	set_parallel_consistency (bool on_off)
IOSS_NODISCARD bool	get_use_generic_canonical_name () const
void	set_use_generic_canonical_name (bool yes_no)
IOSS_NODISCARD bool	ignore_database_names () const
void	ignore_database_names (bool yes_no)
IOSS_NODISCARD bool	get_ignore_realn_fields () const
void	set_ignore_realn_fields (bool yes_no)
IOSS_NODISCARD std::string	get_component_name (const Ioss::Field &field, Ioss::Field::InOut in_out, int component) const
IOSS_NODISCARD char	get_field_separator () const
IOSS_NODISCARD bool	get_field_recognition () const
IOSS_NODISCARD bool	get_field_strip_trailing_ () const
void	set_field_separator (char separator)
	Set the character used to separate a field suffix from the field basename when recognizing vector, tensor fields.
void	set_field_recognition (bool yes_no)
void	set_field_strip_trailing_ (bool yes_no)
IOSS_NODISCARD DuplicateFieldBehavior	get_duplicate_field_behavior () const
void	set_lower_case_variable_names (bool true_false) const
void	set_surface_split_type (Ioss::SurfaceSplitType split_type)
IOSS_NODISCARD Ioss::SurfaceSplitType	get_surface_split_type () const
void	set_block_omissions (const std::vector< std::string > &omissions, const std::vector< std::string > &inclusions={})
void	set_assembly_omissions (const std::vector< std::string > &omissions, const std::vector< std::string > &inclusions={})
void	get_block_adjacencies (const Ioss::ElementBlock *eb, std::vector< std::string > &block_adjacency) const
void	compute_block_membership (Ioss::SideBlock *efblock, std::vector< std::string > &block_membership) const
IOSS_NODISCARD AxisAlignedBoundingBox	get_bounding_box (const Ioss::NodeBlock *nb) const
IOSS_NODISCARD AxisAlignedBoundingBox	get_bounding_box (const Ioss::ElementBlock *eb) const
IOSS_NODISCARD AxisAlignedBoundingBox	get_bounding_box (const Ioss::StructuredBlock *sb) const
IOSS_NODISCARD int	int_byte_size_api () const
	Returns 4 or 8.
IOSS_NODISCARD Region *	get_region () const
void	set_cycle_count (int count) const
IOSS_NODISCARD int	get_cycle_count () const
void	set_overlay_count (int count) const
IOSS_NODISCARD int	get_overlay_count () const
void	set_file_per_state (bool yes_no) const
IOSS_NODISCARD bool	get_file_per_state () const
void	set_time_scale_factor (double factor)
IOSS_NODISCARD const Ioss::ParallelUtils &	util () const
IOSS_NODISCARD const Ioss::PropertyManager &	get_property_manager () const
IOSS_NODISCARD int	parallel_rank () const
	Get the processor that this mesh database is on.
IOSS_NODISCARD int	parallel_size () const
IOSS_NODISCARD bool	is_parallel () const
void	progress (const std::string &output) const
virtual std::vector< size_t >	get_entity_field_data (const std::string &field_name, const std::vector< Ioss::ElementBlock * > &elem_blocks, void *data, size_t data_size) const
template<>
void	create_group (EntityType type, const std::string &, const std::vector< std::string > &group_spec, const SideSet *)

Protected Member Functions
IOSS_NODISCARD bool	ok_nl (bool write_message=false, std::string *error_message=nullptr, int *bad_count=nullptr) const override
bool	open_group_nl (const std::string &group_name) override
bool	create_subgroup_nl (const std::string &group_name) override
bool	begin_nl (Ioss::State state) override
bool	end_nl (Ioss::State state) override
void	open_state_file (int state)
bool	begin_state_nl (int state, double time) override
bool	end_state_nl (int state, double time) override
IOSS_NODISCARD int	maximum_symbol_length () const override
	Get the length of the longest name in the database file.
void	set_maximum_symbol_length (int requested_symbol_size) override
size_t	handle_block_ids (const Ioss::EntityBlock *eb, ex_entity_type map_type, Ioss::Map &entity_map, void *ids, size_t num_to_get, size_t offset) const
void	compute_block_membership_nl (Ioss::SideBlock *efblock, std::vector< std::string > &block_membership) const override
IOSS_NODISCARD int	int_byte_size_db () const override
void	set_int_byte_size_api (Ioss::DataSize size) const override
	Returns 4 or 8.
int64_t	get_field_internal (const Ioss::Region *reg, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::NodeBlock *nb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::EdgeBlock *nb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::FaceBlock *nb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::ElementBlock *eb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::StructuredBlock *sb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::SideBlock *fb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::NodeSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::EdgeSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::FaceSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::ElementSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::SideSet *fs, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::CommSet *cs, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::Assembly *as, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	get_field_internal (const Ioss::Blob *blob, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::Region *reg, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::NodeBlock *nb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::EdgeBlock *nb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::FaceBlock *nb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::ElementBlock *eb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::StructuredBlock *sb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::SideBlock *fb, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::NodeSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::EdgeSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::FaceSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::ElementSet *ns, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::SideSet *fs, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::CommSet *cs, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::Assembly *as, const Ioss::Field &field, void *data, size_t data_size) const override=0
int64_t	put_field_internal (const Ioss::Blob *blob, const Ioss::Field &field, void *data, size_t data_size) const override=0
virtual void	write_meta_data (Ioss::IfDatabaseExistsBehavior behavior)=0
void	write_results_metadata (bool gather_data, Ioss::IfDatabaseExistsBehavior behavior)
void	openDatabase_nl () const override
void	closeDatabase_nl () const override
IOSS_NODISCARD int	get_file_pointer () const override=0
virtual int	free_file_pointer () const
virtual bool	open_input_file (bool write_message, std::string *error_msg, int *bad_count, bool abort_if_error) const =0
virtual bool	handle_output_file (bool write_message, std::string *error_msg, int *bad_count, bool overwrite, bool abort_if_error) const =0
void	finalize_file_open () const
IOSS_NODISCARD int	get_current_state () const
void	put_qa ()
void	put_info ()
template<typename T >
void	internal_gather_results_metadata (ex_entity_type type, std::vector< T * > entities)
void	generate_sideset_truth_table ()
void	output_results_names (ex_entity_type type, VariableNameMap &variables, bool reduction) const
int	gather_names (VariableNameMap &variables, const Ioss::GroupingEntity *ge, int index, bool reduction)
void	get_nodeblocks ()
void	get_assemblies ()
void	get_blobs ()
void	update_block_omissions_from_assemblies ()
void	add_attribute_fields (Ioss::GroupingEntity *block, int attribute_count, const std::string &type)
void	common_write_meta_data (Ioss::IfDatabaseExistsBehavior behavior)
void	output_other_meta_data ()
int64_t	internal_add_results_fields (ex_entity_type type, Ioss::GroupingEntity *entity, int64_t position, int64_t block_count, Ioss::IntVector &truth_table, Ioex::VariableNameMap &variables)
int64_t	add_results_fields (Ioss::GroupingEntity *entity, int64_t position=0)
int64_t	add_reduction_results_fields (Ioss::GroupingEntity *entity)
void	add_mesh_reduction_fields (int64_t id, Ioss::GroupingEntity *entity)
void	add_region_fields ()
void	store_reduction_field (const Ioss::Field &field, const Ioss::GroupingEntity *ge, void *variables) const
void	get_reduction_field (const Ioss::Field &field, const Ioss::GroupingEntity *ge, void *variables) const
void	write_reduction_fields () const
void	read_reduction_fields () const
IOSS_NODISCARD int	get_database_step (int global_step) const
void	flush_database_nl () const override
void	finalize_write (int state, double sim_time)
Protected Member Functions inherited from Ioss::DatabaseIO
	DatabaseIO (Region *region, std::string filename, Ioss::DatabaseUsage db_usage, Ioss_MPI_Comm communicator, const Ioss::PropertyManager &props)
void	set_common_side_topology () const
template<typename T >
void	create_groups (const std::string &property_name, EntityType type, const std::string &type_name, const T *set_type)
template<typename T >
void	create_group (EntityType type, const std::string &type_name, const std::vector< std::string > &group_spec, const T *set_type)
void	handle_groups ()
void	check_side_topology () const

Protected Attributes
int	m_exodusFilePtr {-1}
int	m_exodusBasePtr {-1}
std::string	m_groupName
EntityIdSet	ids_
int	exodusMode {EX_CLOBBER}
int	dbRealWordSize {8}
int	maximumNameLength {32}
int	spatialDimension {0}
int64_t	edgeCount {0}
int64_t	faceCount {0}
std::map< ex_entity_type, int >	m_groupCount
Ioss::Int64Vector	nodeCmapIds
Ioss::Int64Vector	nodeCmapNodeCnts
Ioss::Int64Vector	elemCmapIds
Ioss::Int64Vector	elemCmapElemCnts
int64_t	commsetNodeCount {0}
int64_t	commsetElemCount {0}
std::map< ex_entity_type, Ioss::IntVector >	m_truthTable
std::map< ex_entity_type, VariableNameMap >	m_variables
std::map< ex_entity_type, VariableNameMap >	m_reductionVariables
std::map< ex_entity_type, std::map< int64_t, ValueContainer > >	m_reductionValues
std::vector< unsigned char >	nodeConnectivityStatus
std::map< std::string, Ioss::Int64Vector >	activeNodeSetNodesIndex
time_t	timeLastFlush {0}
int	flushInterval {-1}
bool	fileExists {false}
bool	minimizeOpenFiles {false}
bool	blockAdjacenciesCalculated {false}
bool	nodeConnectivityStatusCalculated
Protected Attributes inherited from Ioss::DatabaseIO
Ioss::PropertyManager	properties
ElementTopology *	commonSideTopology {nullptr}
std::string	originalDBFilename {}
std::string	DBFilename {}
std::string	decodedFilename {}
std::string	bbName {}
std::string	pfsName {}
std::string	dwPath {}
Ioss::State	dbState {STATE_INVALID}
int	myProcessor {0}
	number of processor this database is for
int64_t	nodeCount {0}
int64_t	elementCount {0}
TopoContainer	sideTopology {}
	Used to speed up faceblock/edgeblock calculations.
int	cycleCount {0}
int	overlayCount {0}
double	timeScaleFactor {1.0}
Ioss::SurfaceSplitType	splitType {SPLIT_BY_TOPOLOGIES}
Ioss::DatabaseUsage	dbUsage {}
Ioss::DataSize	dbIntSizeAPI {USE_INT32_API}
bool	filePerState {false}
bool	usingDataWarp {false}
bool	isParallel {false}
	true if running in parallel
bool	lowerCaseVariableNames {true}
bool	usingParallelIO {false}
std::vector< std::string >	blockOmissions {}
std::vector< std::string >	blockInclusions {}
std::vector< std::string >	assemblyOmissions {}
std::vector< std::string >	assemblyInclusions {}
std::vector< std::string >	informationRecords {}
std::vector< std::string >	qaRecords {}
Ioss::Map	nodeMap {"node", DBFilename, myProcessor}
Ioss::Map	edgeMap {"edge", DBFilename, myProcessor}
Ioss::Map	faceMap {"face", DBFilename, myProcessor}
Ioss::Map	elemMap {"element", DBFilename, myProcessor}
std::vector< std::vector< bool > >	blockAdjacency

Constructor & Destructor Documentation

BaseDatabaseIO()

Ioex::BaseDatabaseIO::BaseDatabaseIO	(	Ioss::Region *	region,
		const std::string &	filename,
		Ioss::DatabaseUsage	db_usage,
		Ioss_MPI_Comm	communicator,
		const Ioss::PropertyManager &	props )

~BaseDatabaseIO()

Ioex::BaseDatabaseIO::~BaseDatabaseIO ( )

override

Member Function Documentation

add_attribute_fields()

void Ioex::BaseDatabaseIO::add_attribute_fields ( Ioss::GroupingEntity * block, int attribute_count, const std::string & type )

protected

Todo

REFACTOR Some of the attribute knowledge should be at the Ioss::ElementTopology level instead of here. That would make it easier for an application to register a new element type and its attributes.

add_mesh_reduction_fields()

void Ioex::BaseDatabaseIO::add_mesh_reduction_fields ( int64_t id, Ioss::GroupingEntity * entity )

protected

add_reduction_results_fields()

int64_t Ioex::BaseDatabaseIO::add_reduction_results_fields ( Ioss::GroupingEntity * entity )

protected

add_region_fields()

void Ioex::BaseDatabaseIO::add_region_fields ( )

protected

add_results_fields()

int64_t Ioex::BaseDatabaseIO::add_results_fields ( Ioss::GroupingEntity * entity, int64_t position = 0 )

protected

begin_nl()

bool Ioex::BaseDatabaseIO::begin_nl ( Ioss::State state )

overrideprotectedvirtual

Implements Ioss::DatabaseIO.

begin_state_nl()

bool Ioex::BaseDatabaseIO::begin_state_nl ( int state, double time )

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

closeDatabase_nl()

void Ioex::BaseDatabaseIO::closeDatabase_nl ( ) const

inlineoverrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

common_write_meta_data()

void Ioex::BaseDatabaseIO::common_write_meta_data ( Ioss::IfDatabaseExistsBehavior behavior )

protected

compute_block_membership_nl()

void Ioex::BaseDatabaseIO::compute_block_membership_nl ( Ioss::SideBlock * efblock, std::vector< std::string > & block_membership ) const

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

create_subgroup_nl()

bool Ioex::BaseDatabaseIO::create_subgroup_nl ( const std::string & group_name )

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

end_nl()

bool Ioex::BaseDatabaseIO::end_nl ( Ioss::State state )

overrideprotectedvirtual

Implements Ioss::DatabaseIO.

end_state_nl()

bool Ioex::BaseDatabaseIO::end_state_nl ( int state, double time )

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

entity_field_support()

unsigned Ioex::BaseDatabaseIO::entity_field_support ( ) const

overridevirtual

Implements Ioss::DatabaseIO.

finalize_file_open()

void Ioex::BaseDatabaseIO::finalize_file_open ( ) const

protected

finalize_write()

void Ioex::BaseDatabaseIO::finalize_write ( int state, double sim_time )

protected

flush_database_nl()

void Ioex::BaseDatabaseIO::flush_database_nl ( ) const

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

free_file_pointer()

int Ioex::BaseDatabaseIO::free_file_pointer ( ) const

protectedvirtual

gather_names()

int Ioex::BaseDatabaseIO::gather_names ( VariableNameMap & variables, const Ioss::GroupingEntity * ge, int index, bool reduction )

protected

generate_sideset_truth_table()

void Ioex::BaseDatabaseIO::generate_sideset_truth_table ( )

protected

get_assemblies()

void Ioex::BaseDatabaseIO::get_assemblies ( )

protected

get_blobs()

void Ioex::BaseDatabaseIO::get_blobs ( )

protected

get_current_state()

int Ioex::BaseDatabaseIO::get_current_state ( ) const

protected

get_database_step()

int Ioex::BaseDatabaseIO::get_database_step ( int global_step ) const

protected

get_field_internal() [1/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::Assembly * as, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [2/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::Blob * blob, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [3/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::CommSet * cs, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [4/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::EdgeBlock * nb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [5/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::EdgeSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [6/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::ElementBlock * eb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [7/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::ElementSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [8/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::FaceBlock * nb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [9/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::FaceSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [10/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::NodeBlock * nb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [11/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::NodeSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [12/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::Region * reg, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [13/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::SideBlock * fb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [14/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::SideSet * fs, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_field_internal() [15/15]

int64_t Ioex::BaseDatabaseIO::get_field_internal ( const Ioss::StructuredBlock * sb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_file_pointer()

int Ioex::BaseDatabaseIO::get_file_pointer ( ) const

overrideprotectedpure virtual

For the database types that support it, return an integer handle through which a client can directly access the underlying file. Please use sparingly and with discretion. Basically, a kluge

Reimplemented from Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

get_format()

IOSS_NODISCARD std::string Ioex::BaseDatabaseIO::get_format ( ) const

inlineoverridevirtual

Return a string specifying underlying format of database (exodus, cgns, ...)

Implements Ioss::DatabaseIO.

get_nodeblocks()

void Ioex::BaseDatabaseIO::get_nodeblocks ( )

protected

get_reduction_field()

void Ioex::BaseDatabaseIO::get_reduction_field ( const Ioss::Field & field, const Ioss::GroupingEntity * ge, void * variables ) const

protected

handle_block_ids()

size_t Ioex::BaseDatabaseIO::handle_block_ids ( const Ioss::EntityBlock * eb, ex_entity_type map_type, Ioss::Map & entity_map, void * ids, size_t num_to_get, size_t offset ) const

protected

NOTE: "element" is generic for "element", "face", or "edge"

There are two modes we need to support in this routine:

1. Initial definition of element map (local->global) and elemMap.reverse (global->local).
2. Redefinition of element map via 'reordering' of the original map when the elements on this processor are the same, but their order is changed.

So, there will be two maps the 'elemMap.map' map is a 'direct lookup' map which maps current local position to global id and the 'elemMap.reverse' is an associative lookup which maps the global id to 'original local'. There is also a 'elemMap.reorder' which is direct lookup and maps current local position to original local.

The ids coming in are the global ids; their position is the local id -1 (That is, data[0] contains the global id of local element 1 in this element block). The 'model-local' id is given by eb_offset + 1 + position:

int local_position = elemMap.reverse[ElementMap[i+1]] (the elemMap.map and elemMap.reverse are 1-based)

But, this assumes 1..numel elements are being output at the same time; we are actually outputting a blocks worth of elements at a time, so we need to consider the block offsets. So... local-in-block position 'i' is index 'eb_offset+i' in 'elemMap.map' and the 'local_position' within the element blocks data arrays is 'local_position-eb_offset'. With this, the position within the data array of this element block is:

int eb_position = elemMap.reverse[elemMap.map[eb_offset+i+1]]-eb_offset-1

To determine which map to update on a call to this function, we use the following heuristics: – If the database state is 'Ioss::STATE_MODEL:', then update the 'elemMap.reverse'. – If the database state is not Ioss::STATE_MODEL, then leave the 'elemMap.reverse' alone since it corresponds to the information already written to the database. [May want to add a Ioss::STATE_REDEFINE_MODEL] – Always update elemMap.map to match the passed in 'ids' array.

NOTE: the maps are built an element block at a time... NOTE: The mapping is done on TRANSIENT fields only; MODEL fields should be in the original order...

handle_output_file()

virtual bool Ioex::BaseDatabaseIO::handle_output_file ( bool write_message, std::string * error_msg, int * bad_count, bool overwrite, bool abort_if_error ) const

protectedpure virtual

Implemented in Ioex::DatabaseIO.

int_byte_size_db()

int Ioex::BaseDatabaseIO::int_byte_size_db ( ) const

overrideprotectedvirtual

Implements Ioss::DatabaseIO.

internal_add_results_fields()

int64_t Ioex::BaseDatabaseIO::internal_add_results_fields ( ex_entity_type type, Ioss::GroupingEntity * entity, int64_t position, int64_t block_count, Ioss::IntVector & truth_table, Ioex::VariableNameMap & variables )

protected

internal_gather_results_metadata()

template<typename T >

void Ioex::BaseDatabaseIO::internal_gather_results_metadata ( ex_entity_type type, std::vector< T * > entities )

protected

maximum_symbol_length()

IOSS_NODISCARD int Ioex::BaseDatabaseIO::maximum_symbol_length ( ) const

inlineoverrideprotectedvirtual

Get the length of the longest name in the database file.

Returns

The length, or 0 for unlimited.

Reimplemented from Ioss::DatabaseIO.

ok_nl()

bool Ioex::BaseDatabaseIO::ok_nl ( bool write_message = false, std::string * error_message = nullptr, int * bad_count = nullptr ) const

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

open_group_nl()

bool Ioex::BaseDatabaseIO::open_group_nl ( const std::string & group_name )

overrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

open_input_file()

virtual bool Ioex::BaseDatabaseIO::open_input_file ( bool write_message, std::string * error_msg, int * bad_count, bool abort_if_error ) const

protectedpure virtual

Implemented in Ioex::DatabaseIO.

open_state_file()

void Ioex::BaseDatabaseIO::open_state_file ( int state )

protected

openDatabase_nl()

void Ioex::BaseDatabaseIO::openDatabase_nl ( ) const

inlineoverrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

output_other_meta_data()

void Ioex::BaseDatabaseIO::output_other_meta_data ( )

protected

output_results_names()

void Ioex::BaseDatabaseIO::output_results_names ( ex_entity_type type, VariableNameMap & variables, bool reduction ) const

protected

put_field_internal() [1/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::Assembly * as, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [2/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::Blob * blob, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [3/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::CommSet * cs, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [4/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::EdgeBlock * nb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [5/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::EdgeSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [6/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::ElementBlock * eb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [7/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::ElementSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [8/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::FaceBlock * nb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [9/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::FaceSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [10/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::NodeBlock * nb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [11/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::NodeSet * ns, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [12/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::Region * reg, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [13/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::SideBlock * fb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [14/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::SideSet * fs, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_field_internal() [15/15]

int64_t Ioex::BaseDatabaseIO::put_field_internal ( const Ioss::StructuredBlock * sb, const Ioss::Field & field, void * data, size_t data_size ) const

overrideprotectedpure virtual

Implements Ioss::DatabaseIO.

Implemented in Ioex::DatabaseIO.

put_info()

void Ioex::BaseDatabaseIO::put_info ( )

protected

put_qa()

void Ioex::BaseDatabaseIO::put_qa ( )

protected

read_reduction_fields()

void Ioex::BaseDatabaseIO::read_reduction_fields ( ) const

protected

set_int_byte_size_api()

void Ioex::BaseDatabaseIO::set_int_byte_size_api ( Ioss::DataSize size ) const

overrideprotectedvirtual

Returns 4 or 8.

Set the number of bytes used to represent an integer.

Parameters

[in]

size

The number of bytes. This is 4 for INT32 or 8 for INT64.

Reimplemented from Ioss::DatabaseIO.

set_maximum_symbol_length()

void Ioex::BaseDatabaseIO::set_maximum_symbol_length ( int requested_symbol_size )

inlineoverrideprotectedvirtual

Reimplemented from Ioss::DatabaseIO.

store_reduction_field()

void Ioex::BaseDatabaseIO::store_reduction_field ( const Ioss::Field & field, const Ioss::GroupingEntity * ge, void * variables ) const

protected

update_block_omissions_from_assemblies()

void Ioex::BaseDatabaseIO::update_block_omissions_from_assemblies ( )

protected

write_meta_data()

virtual void Ioex::BaseDatabaseIO::write_meta_data ( Ioss::IfDatabaseExistsBehavior behavior )

protectedpure virtual

Implemented in Ioex::DatabaseIO.

write_reduction_fields()

void Ioex::BaseDatabaseIO::write_reduction_fields ( ) const

protected

write_results_metadata()

void Ioex::BaseDatabaseIO::write_results_metadata ( bool gather_data, Ioss::IfDatabaseExistsBehavior behavior )

protected

Member Data Documentation

activeNodeSetNodesIndex

std::map<std::string, Ioss::Int64Vector> Ioex::BaseDatabaseIO::activeNodeSetNodesIndex

mutableprotected

blockAdjacenciesCalculated

bool Ioex::BaseDatabaseIO::blockAdjacenciesCalculated {false}

mutableprotected

commsetElemCount

int64_t Ioex::BaseDatabaseIO::commsetElemCount {0}

protected

commsetNodeCount

int64_t Ioex::BaseDatabaseIO::commsetNodeCount {0}

protected

dbRealWordSize

int Ioex::BaseDatabaseIO::dbRealWordSize {8}

mutableprotected

edgeCount

int64_t Ioex::BaseDatabaseIO::edgeCount {0}

protected

elemCmapElemCnts

Ioss::Int64Vector Ioex::BaseDatabaseIO::elemCmapElemCnts

protected

elemCmapIds

Ioss::Int64Vector Ioex::BaseDatabaseIO::elemCmapIds

protected

exodusMode

int Ioex::BaseDatabaseIO::exodusMode {EX_CLOBBER}

mutableprotected

faceCount

int64_t Ioex::BaseDatabaseIO::faceCount {0}

protected

fileExists

bool Ioex::BaseDatabaseIO::fileExists {false}

mutableprotected

flushInterval

int Ioex::BaseDatabaseIO::flushInterval {-1}

protected

ids_

EntityIdSet Ioex::BaseDatabaseIO::ids_

mutableprotected

m_exodusBasePtr

int Ioex::BaseDatabaseIO::m_exodusBasePtr {-1}

mutableprotected

m_exodusFilePtr

int Ioex::BaseDatabaseIO::m_exodusFilePtr {-1}

mutableprotected

m_groupCount

std::map<ex_entity_type, int> Ioex::BaseDatabaseIO::m_groupCount

mutableprotected

m_groupName

std::string Ioex::BaseDatabaseIO::m_groupName

mutableprotected

m_reductionValues

std::map<ex_entity_type, std::map<int64_t, ValueContainer> > Ioex::BaseDatabaseIO::m_reductionValues

mutableprotected

m_reductionVariables

std::map<ex_entity_type, VariableNameMap> Ioex::BaseDatabaseIO::m_reductionVariables

mutableprotected

m_truthTable

std::map<ex_entity_type, Ioss::IntVector> Ioex::BaseDatabaseIO::m_truthTable

mutableprotected

m_variables

std::map<ex_entity_type, VariableNameMap> Ioex::BaseDatabaseIO::m_variables

mutableprotected

maximumNameLength

int Ioex::BaseDatabaseIO::maximumNameLength {32}

mutableprotected

minimizeOpenFiles

bool Ioex::BaseDatabaseIO::minimizeOpenFiles {false}

mutableprotected

nodeCmapIds

Ioss::Int64Vector Ioex::BaseDatabaseIO::nodeCmapIds

protected

nodeCmapNodeCnts

Ioss::Int64Vector Ioex::BaseDatabaseIO::nodeCmapNodeCnts

protected

nodeConnectivityStatus

std::vector<unsigned char> Ioex::BaseDatabaseIO::nodeConnectivityStatus

mutableprotected

nodeConnectivityStatusCalculated

bool Ioex::BaseDatabaseIO::nodeConnectivityStatusCalculated

mutableprotected

Initial value:

{
        false}

spatialDimension

int Ioex::BaseDatabaseIO::spatialDimension {0}

protected

timeLastFlush

time_t Ioex::BaseDatabaseIO::timeLastFlush {0}

protected

---

The documentation for this class was generated from the following files:

• src/exodus/Ioex_BaseDatabaseIO.h
• src/exodus/Ioex_BaseDatabaseIO.C