polyfem::io Namespace Reference

Classes
class	CheckpointMetadata
class	CheckpointReader
class	CheckpointWriter
class	EnergyCSVWriter
class	Evaluator
class	FileSystemIO
class	HDF5IO
	HDF5 logical paths always use POSIX separators and roots. More...
class	LoadedInput
class	MshReader
class	MshWriter
class	OBJReader
class	OBJWriter
class	OutGeometryData
	Utilies related to export of geometry. More...
struct	OutputField
struct	OutputFieldOptions
struct	OutputSample
struct	OutputSpace
class	OutRuntimeData
	timers from polyfem. More...
class	OutStatsData
	all stats from polyfem More...
class	ResourceIO
	Read-only interface to a hierarchical collection of simulation resources. More...
class	RuntimeStatsCSVWriter

Typedefs
using	CellType = paraviewo::CellType
using	CellElement = paraviewo::CellElement
using	OutputFieldFunction = std::function< std::vector< OutputField >(const OutputSample &)>

Functions
LoadedInput	load_json_input (const std::filesystem::path &path)
LoadedInput	load_yaml_input (const std::filesystem::path &path)
LoadedInput	load_hdf5_input (const std::filesystem::path &path)
template<typename T >
bool	read_matrix (const std::string &path, Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &mat)
	Reads a matrix from a file. Determines the file format based on the path's extension.
template<typename Mat >
bool	write_matrix (const std::string &path, const Mat &mat)
	Writes a matrix to a file. Determines the file format based on the path's extension.
template<typename Mat >
bool	write_matrix (const std::string &path, const std::string &key, const Mat &mat, const bool replace=true)
	Writes a matrix to a hdf5 file using key as name.
template<typename Mat >
bool	read_matrix (const std::string &path, const std::string &key, Mat &mat)
	Reads a matrix to a hdf5 file using key as name.
template<typename T >
bool	read_matrix_ascii (const std::string &path, Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &mat)
template<typename Mat >
bool	write_matrix_ascii (const std::string &path, const Mat &mat)
template<typename T >
bool	read_matrix_binary (const std::string &path, Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &mat)
template<typename Mat >
bool	write_matrix_binary (const std::string &path, const Mat &mat)
bool	write_sparse_matrix_csv (const std::string &path, const Eigen::SparseMatrix< double > &mat)
template<typename T >
bool	import_matrix (const std::string &path, const json &import, Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &mat)
template bool	read_matrix< int > (const std::string &, Eigen::Matrix< int, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix< double > (const std::string &, Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix< long > (const std::string &, Eigen::Matrix< long, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix< Eigen::MatrixXi > (const std::string &, const std::string &, Eigen::MatrixXi &)
template bool	read_matrix< Eigen::MatrixXd > (const std::string &, const std::string &, Eigen::MatrixXd &)
template bool	write_matrix< Eigen::MatrixXd > (const std::string &, const Eigen::MatrixXd &)
template bool	write_matrix< Eigen::MatrixXf > (const std::string &, const Eigen::MatrixXf &)
template bool	write_matrix< Eigen::VectorXd > (const std::string &, const Eigen::VectorXd &)
template bool	write_matrix< Eigen::VectorXf > (const std::string &, const Eigen::VectorXf &)
template bool	write_matrix< Eigen::MatrixXd > (const std::string &, const std::string &, const Eigen::MatrixXd &, const bool)
template bool	write_matrix< Eigen::MatrixXf > (const std::string &, const std::string &, const Eigen::MatrixXf &, const bool)
template bool	write_matrix< Eigen::VectorXd > (const std::string &, const std::string &, const Eigen::VectorXd &, const bool)
template bool	write_matrix< Eigen::VectorXf > (const std::string &, const std::string &, const Eigen::VectorXf &, const bool)
template bool	read_matrix_ascii< int > (const std::string &, Eigen::Matrix< int, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix_ascii< double > (const std::string &, Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix_ascii< long > (const std::string &, Eigen::Matrix< long, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	write_matrix_ascii< Eigen::MatrixXd > (const std::string &, const Eigen::MatrixXd &)
template bool	write_matrix_ascii< Eigen::MatrixXf > (const std::string &, const Eigen::MatrixXf &)
template bool	write_matrix_ascii< Eigen::VectorXd > (const std::string &, const Eigen::VectorXd &)
template bool	write_matrix_ascii< Eigen::VectorXf > (const std::string &, const Eigen::VectorXf &)
template bool	read_matrix_binary< int > (const std::string &, Eigen::Matrix< int, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix_binary< double > (const std::string &, Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	read_matrix_binary< long > (const std::string &, Eigen::Matrix< long, Eigen::Dynamic, Eigen::Dynamic > &)
template bool	write_matrix_binary< Eigen::MatrixXd > (const std::string &, const Eigen::MatrixXd &)
template bool	write_matrix_binary< Eigen::MatrixXf > (const std::string &, const Eigen::MatrixXf &)
template bool	write_matrix_binary< Eigen::VectorXd > (const std::string &, const Eigen::VectorXd &)
template bool	write_matrix_binary< Eigen::VectorXf > (const std::string &, const Eigen::VectorXf &)
template bool	import_matrix< int > (const std::string &path, const json &import, Eigen::MatrixXi &mat)
template bool	import_matrix< double > (const std::string &path, const json &import, Eigen::MatrixXd &mat)
template<typename Entity >
void	map_entity_tag_to_physical_tag (const std::vector< Entity > &entities, std::unordered_map< int, int > &entity_tag_to_physical_tag)
LoadedInput	load_json_input (const fs::path &path)
LoadedInput	load_yaml_input (const fs::path &path)
LoadedInput	load_hdf5_input (const fs::path &path)
json	yaml_string_to_json (const std::string &yaml_str)
	Convert YAML string to JSON.

Variables
constexpr long	CHECKPOINT_SCHEMA_VERSION = 1

Typedef Documentation

CellElement

using polyfem::io::CellElement = typedef paraviewo::CellElement

Definition at line 62 of file OutData.cpp.

CellType

using polyfem::io::CellType = typedef paraviewo::CellType

Definition at line 61 of file OutData.cpp.

OutputFieldFunction

using polyfem::io::OutputFieldFunction = typedef std::function<std::vector<OutputField>(const OutputSample &)>

Definition at line 73 of file OutputData.hpp.

Function Documentation

import_matrix()

template<typename T >

bool polyfem::io::import_matrix	(	const std::string &	path,
		const json &	import,
		Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &	mat
	)

Definition at line 245 of file MatrixIO.cpp.

References read_matrix().

Here is the call graph for this function:

import_matrix< double >()

template bool polyfem::io::import_matrix< double >	(	const std::string &	path,
		const json &	import,
		Eigen::MatrixXd &	mat
	)

import_matrix< int >()

template bool polyfem::io::import_matrix< int >	(	const std::string &	path,
		const json &	import,
		Eigen::MatrixXi &	mat
	)

load_hdf5_input() [1/2]

LoadedInput polyfem::io::load_hdf5_input

(

const fs::path &

path

)

Definition at line 609 of file ResourceIO.cpp.

References polyfem::log_and_throw_error(), and polyfem::logger().

Here is the call graph for this function:

load_hdf5_input() [2/2]

LoadedInput polyfem::io::load_hdf5_input

(

const std::filesystem::path &

path

)

Referenced by main().

Here is the caller graph for this function:

load_json_input() [1/2]

LoadedInput polyfem::io::load_json_input

(

const fs::path &

path

)

Definition at line 595 of file ResourceIO.cpp.

load_json_input() [2/2]

LoadedInput polyfem::io::load_json_input

(

const std::filesystem::path &

path

)

Referenced by main().

Here is the caller graph for this function:

load_yaml_input() [1/2]

LoadedInput polyfem::io::load_yaml_input

(

const fs::path &

path

)

Definition at line 602 of file ResourceIO.cpp.

References yaml_string_to_json().

Here is the call graph for this function:

load_yaml_input() [2/2]

LoadedInput polyfem::io::load_yaml_input

(

const std::filesystem::path &

path

)

Referenced by main().

Here is the caller graph for this function:

map_entity_tag_to_physical_tag()

template<typename Entity >

void polyfem::io::map_entity_tag_to_physical_tag	(	const std::vector< Entity > &	entities,
		std::unordered_map< int, int > &	entity_tag_to_physical_tag
	)

Definition at line 32 of file MshReader.cpp.

Referenced by polyfem::io::MshReader::load().

Here is the caller graph for this function:

read_matrix() [1/2]

template<typename Mat >

bool polyfem::io::read_matrix	(	const std::string &	path,
		const std::string &	key,
		Mat &	mat
	)

Reads a matrix to a hdf5 file using key as name.

Definition at line 74 of file MatrixIO.cpp.

read_matrix() [2/2]

template<typename T >

bool polyfem::io::read_matrix	(	const std::string &	path,
		Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &	mat
	)

Reads a matrix from a file. Determines the file format based on the path's extension.

Definition at line 19 of file MatrixIO.cpp.

References read_matrix_ascii(), and read_matrix_binary().

Referenced by polyfem::legacy::State::build_basis(), and import_matrix().

Here is the call graph for this function:

Here is the caller graph for this function:

read_matrix< double >()

template bool polyfem::io::read_matrix< double >	(	const std::string &	,
		Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix< Eigen::MatrixXd >()

template bool polyfem::io::read_matrix< Eigen::MatrixXd >	(	const std::string &	,
		const std::string &	,
		Eigen::MatrixXd &
	)

read_matrix< Eigen::MatrixXi >()

template bool polyfem::io::read_matrix< Eigen::MatrixXi >	(	const std::string &	,
		const std::string &	,
		Eigen::MatrixXi &
	)

read_matrix< int >()

template bool polyfem::io::read_matrix< int >	(	const std::string &	,
		Eigen::Matrix< int, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix< long >()

template bool polyfem::io::read_matrix< long >	(	const std::string &	,
		Eigen::Matrix< long, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix_ascii()

template<typename T >

bool polyfem::io::read_matrix_ascii	(	const std::string &	path,
		Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &	mat
	)

Definition at line 84 of file MatrixIO.cpp.

References polyfem::logger().

Referenced by read_matrix().

Here is the call graph for this function:

Here is the caller graph for this function:

read_matrix_ascii< double >()

template bool polyfem::io::read_matrix_ascii< double >	(	const std::string &	,
		Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix_ascii< int >()

template bool polyfem::io::read_matrix_ascii< int >	(	const std::string &	,
		Eigen::Matrix< int, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix_ascii< long >()

template bool polyfem::io::read_matrix_ascii< long >	(	const std::string &	,
		Eigen::Matrix< long, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix_binary()

template<typename T >

bool polyfem::io::read_matrix_binary	(	const std::string &	path,
		Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > &	mat
	)

Definition at line 155 of file MatrixIO.cpp.

References polyfem::logger().

Referenced by read_matrix().

Here is the call graph for this function:

Here is the caller graph for this function:

read_matrix_binary< double >()

template bool polyfem::io::read_matrix_binary< double >	(	const std::string &	,
		Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix_binary< int >()

template bool polyfem::io::read_matrix_binary< int >	(	const std::string &	,
		Eigen::Matrix< int, Eigen::Dynamic, Eigen::Dynamic > &
	)

read_matrix_binary< long >()

template bool polyfem::io::read_matrix_binary< long >	(	const std::string &	,
		Eigen::Matrix< long, Eigen::Dynamic, Eigen::Dynamic > &
	)

write_matrix() [1/2]

template<typename Mat >

bool polyfem::io::write_matrix	(	const std::string &	path,
		const Mat &	mat
	)

Writes a matrix to a file. Determines the file format based on the path's extension.

Definition at line 43 of file MatrixIO.cpp.

References polyfem::logger(), write_matrix_ascii(), and write_matrix_binary().

Referenced by polyfem::varform::BilaplacianVarForm::export_data(), polyfem::varform::ElasticVarForm::export_data(), polyfem::varform::FluidVarForm::export_data(), polyfem::varform::OperatorSplittingVarForm::export_data(), polyfem::varform::ScalarVarForm::export_data(), polyfem::time_integrator::ImplicitTimeIntegrator::save_state(), polyfem::io::OutGeometryData::save_volume(), and polyfem::legacy::State::solve_problem().

Here is the call graph for this function:

Here is the caller graph for this function:

write_matrix() [2/2]

template<typename Mat >

bool polyfem::io::write_matrix	(	const std::string &	path,
		const std::string &	key,
		const Mat &	mat,
		const bool	replace
	)

Writes a matrix to a hdf5 file using key as name.

Definition at line 65 of file MatrixIO.cpp.

write_matrix< Eigen::MatrixXd >() [1/2]

template bool polyfem::io::write_matrix< Eigen::MatrixXd >	(	const std::string &	,
		const Eigen::MatrixXd &
	)

write_matrix< Eigen::MatrixXd >() [2/2]

template bool polyfem::io::write_matrix< Eigen::MatrixXd >	(	const std::string &	,
		const std::string &	,
		const Eigen::MatrixXd &	,
		const bool
	)

write_matrix< Eigen::MatrixXf >() [1/2]

template bool polyfem::io::write_matrix< Eigen::MatrixXf >	(	const std::string &	,
		const Eigen::MatrixXf &
	)

write_matrix< Eigen::MatrixXf >() [2/2]

template bool polyfem::io::write_matrix< Eigen::MatrixXf >	(	const std::string &	,
		const std::string &	,
		const Eigen::MatrixXf &	,
		const bool
	)

write_matrix< Eigen::VectorXd >() [1/2]

template bool polyfem::io::write_matrix< Eigen::VectorXd >	(	const std::string &	,
		const Eigen::VectorXd &
	)

write_matrix< Eigen::VectorXd >() [2/2]

template bool polyfem::io::write_matrix< Eigen::VectorXd >	(	const std::string &	,
		const std::string &	,
		const Eigen::VectorXd &	,
		const bool
	)

write_matrix< Eigen::VectorXf >() [1/2]

template bool polyfem::io::write_matrix< Eigen::VectorXf >	(	const std::string &	,
		const Eigen::VectorXf &
	)

write_matrix< Eigen::VectorXf >() [2/2]

template bool polyfem::io::write_matrix< Eigen::VectorXf >	(	const std::string &	,
		const std::string &	,
		const Eigen::VectorXf &	,
		const bool
	)

write_matrix_ascii()

template<typename Mat >

bool polyfem::io::write_matrix_ascii	(	const std::string &	path,
		const Mat &	mat
	)

Definition at line 136 of file MatrixIO.cpp.

References polyfem::logger().

Referenced by write_matrix().

Here is the call graph for this function:

Here is the caller graph for this function:

write_matrix_ascii< Eigen::MatrixXd >()

template bool polyfem::io::write_matrix_ascii< Eigen::MatrixXd >	(	const std::string &	,
		const Eigen::MatrixXd &
	)

write_matrix_ascii< Eigen::MatrixXf >()

template bool polyfem::io::write_matrix_ascii< Eigen::MatrixXf >	(	const std::string &	,
		const Eigen::MatrixXf &
	)

write_matrix_ascii< Eigen::VectorXd >()

template bool polyfem::io::write_matrix_ascii< Eigen::VectorXd >	(	const std::string &	,
		const Eigen::VectorXd &
	)

write_matrix_ascii< Eigen::VectorXf >()

template bool polyfem::io::write_matrix_ascii< Eigen::VectorXf >	(	const std::string &	,
		const Eigen::VectorXf &
	)

write_matrix_binary()

template<typename Mat >

bool polyfem::io::write_matrix_binary	(	const std::string &	path,
		const Mat &	mat
	)

Definition at line 191 of file MatrixIO.cpp.

References polyfem::logger().

Referenced by write_matrix().

Here is the call graph for this function:

Here is the caller graph for this function:

write_matrix_binary< Eigen::MatrixXd >()

template bool polyfem::io::write_matrix_binary< Eigen::MatrixXd >	(	const std::string &	,
		const Eigen::MatrixXd &
	)

write_matrix_binary< Eigen::MatrixXf >()

template bool polyfem::io::write_matrix_binary< Eigen::MatrixXf >	(	const std::string &	,
		const Eigen::MatrixXf &
	)

write_matrix_binary< Eigen::VectorXd >()

template bool polyfem::io::write_matrix_binary< Eigen::VectorXd >	(	const std::string &	,
		const Eigen::VectorXd &
	)

write_matrix_binary< Eigen::VectorXf >()

template bool polyfem::io::write_matrix_binary< Eigen::VectorXf >	(	const std::string &	,
		const Eigen::VectorXf &
	)

write_sparse_matrix_csv()

bool polyfem::io::write_sparse_matrix_csv	(	const std::string &	path,
		const Eigen::SparseMatrix< double > &	mat
	)

Definition at line 214 of file MatrixIO.cpp.

References polyfem::logger().

Here is the call graph for this function:

yaml_string_to_json()

json polyfem::io::yaml_string_to_json

(

const std::string &

yaml_str

)

Convert YAML string to JSON.

Definition at line 62 of file YamlToJson.cpp.

Referenced by load_yaml_input().

Here is the caller graph for this function:

Variable Documentation

CHECKPOINT_SCHEMA_VERSION

constexpr long polyfem::io::CHECKPOINT_SCHEMA_VERSION = 1

inlineconstexpr

Definition at line 20 of file Checkpoint.hpp.

Referenced by polyfem::io::CheckpointReader::CheckpointReader().