hummingbird::Results Class Reference

Exports simulation results to a file. More...

#include <results.h>

Collaboration diagram for hummingbird::Results:

Public Member Functions
	Results (const std::string &name, const OutputFormat output_format, const std::vector< Node > &nodes, const QuadratureBase< Ordinate > &angular_quadrature, const unsigned int dimension)
	Construct a new Results object.
void	Export ()
	Export the results in the format given by output_format_.

Private Member Functions
void	ToCSV ()
	Export the results as a CSV file.

Private Attributes
const std::string &	name_
	Problem name, used to build the output file name.
const OutputFormat	output_format_
	Format to export results in.
const std::vector< Node > &	nodes_
	Mesh nodes holding the solution values to export.
const QuadratureBase< Ordinate > &	angular_quadrature_
	Angular quadrature set.
const unsigned int	dimension_
	Spatial dimension of the mesh.

Detailed Description

Exports simulation results to a file.

Definition at line 20 of file results.h.

Constructor & Destructor Documentation

Results()

hummingbird::Results::Results	(	const std::string &	name,
		const OutputFormat	output_format,
		const std::vector< Node > &	nodes,
		const QuadratureBase< Ordinate > &	angular_quadrature,
		const unsigned int	dimension )

Construct a new Results object.

Parameters

name	Problem name, used to build the output file name
output_format	Format to export results in
nodes	Mesh nodes holding the solution values to export
angular_quadrature	Angular quadrature set for the simulation
dimension	Spatial dimension of the mesh. For dimension == 1, each ordinate is exported as a single direction cosine (the only angular quantity that matters in 1D) instead of azimuth/polar.

Definition at line 9 of file results.cc.

Member Function Documentation

Export()

void hummingbird::Results::Export

(

)

Export the results in the format given by output_format_.

Exceptions

std::runtime_error

if output_format_ is not yet supported

Definition at line 19 of file results.cc.

ToCSV()

void hummingbird::Results::ToCSV ( )

private

Export the results as a CSV file.

Definition at line 31 of file results.cc.

Member Data Documentation

angular_quadrature_

const QuadratureBase<Ordinate>& hummingbird::Results::angular_quadrature_

private

Angular quadrature set.

Definition at line 56 of file results.h.

dimension_

const unsigned int hummingbird::Results::dimension_

private

Spatial dimension of the mesh.

Definition at line 59 of file results.h.

name_

const std::string& hummingbird::Results::name_

private

Problem name, used to build the output file name.

Definition at line 47 of file results.h.

nodes_

const std::vector<Node>& hummingbird::Results::nodes_

private

Mesh nodes holding the solution values to export.

Definition at line 53 of file results.h.

output_format_

const OutputFormat hummingbird::Results::output_format_

private

Format to export results in.

Definition at line 50 of file results.h.

---

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

• /home/runner/work/hummingbird/hummingbird/include/utils/results.h
• /home/runner/work/hummingbird/hummingbird/src/utils/results.cc