Controller::Gateway Class Reference

#include "modules/Controller/include/Gateway.hpp"

Inheritance diagram for Controller::Gateway:

Public Member Functions
virtual void	open (std::string filename)=0
virtual void	close ()
virtual std::shared_ptr< PanNDE::Array< double > >	getArray (std::string keyname, std::shared_ptr< PanNDE::ArrayFactory< double >> maker)=0
virtual double	getValue (std::string keyname)=0
virtual std::shared_ptr< PanNDE::Mesh >	getMesh (std::shared_ptr< PanNDE::MeshFactory > maker, int host_id=0)=0
virtual std::shared_ptr< PanNDE::Field >	getField (std::string keyname, std::shared_ptr< PanNDE::FieldFactory > maker, int host_id=0)=0
virtual void	writeSolution (std::string filename_base, std::shared_ptr< PanNDE::FieldBundle > solution, int write_index)=0
virtual void	writeSolution (std::string filename_base, std::shared_ptr< PanNDE::FieldBundle > solution, std::shared_ptr< PanNDE::DataBundle< double >> meta, int write_index)=0
virtual void	writeSolution (std::string filename_base, std::shared_ptr< PanNDE::FieldBundle > solution, std::shared_ptr< PanNDE::DataBundle< double >> meta)=0
virtual void	writeSolution (std::string filename_base, std::shared_ptr< PanNDE::FieldBundle > solution)=0

Detailed Description

Defines the methods required to describe the data for file I/O

Member Function Documentation

close()

virtual void Controller::Gateway::close ( )

inlinevirtual

close files

getArray()

virtual std::shared_ptr<PanNDE::Array<double> > Controller::Gateway::getArray ( std::string  keyname, std::shared_ptr< PanNDE::ArrayFactory< double >>  maker  )

pure virtual

get array by keyname from file

Parameters

keyname	name of variable to be pulled from input file
maker	array factory

Implemented in VTKIO::VTKGateway.

getField()

virtual std::shared_ptr<PanNDE::Field> Controller::Gateway::getField ( std::string  keyname, std::shared_ptr< PanNDE::FieldFactory >  maker, int  host_id = 0  )

pure virtual

get field by keyname from file

Parameters

maker	field factory
host_id	root process to read mesh from file

Implemented in VTKIO::VTKGateway.

getMesh()

virtual std::shared_ptr<PanNDE::Mesh> Controller::Gateway::getMesh ( std::shared_ptr< PanNDE::MeshFactory >  maker, int  host_id = 0  )

pure virtual

get mesh from file

Parameters

maker	mesh factory
host_id	root process to read mesh from file

Implemented in VTKIO::VTKGateway.

getValue()

virtual double Controller::Gateway::getValue ( std::string  keyname )

pure virtual

get value by keyname from file

Parameters

keyname

name of variable to be pulled from input file

Implemented in VTKIO::VTKGateway.

open()

virtual void Controller::Gateway::open ( std::string  filename )

pure virtual

open file for read

Parameters

filename

the name of the file (using relative addr)

Implemented in VTKIO::VTKGateway.

writeSolution() [1/4]

virtual void Controller::Gateway::writeSolution ( std::string  filename_base, std::shared_ptr< PanNDE::FieldBundle >  solution  )

pure virtual

write solution variables to file

Parameters

filename_base	base name for file write
solution	bundled solution data

Implemented in VTKIO::VTKGateway.

writeSolution() [2/4]

virtual void Controller::Gateway::writeSolution ( std::string  filename_base, std::shared_ptr< PanNDE::FieldBundle >  solution, int  write_index  )

pure virtual

write solution variables to file

Parameters

filename_base	base name for file write
solution	bundled solution data
write_index	time index to be written

Implemented in VTKIO::VTKGateway.

writeSolution() [3/4]

virtual void Controller::Gateway::writeSolution ( std::string  filename_base, std::shared_ptr< PanNDE::FieldBundle >  solution, std::shared_ptr< PanNDE::DataBundle< double >>  meta  )

pure virtual

write solution variables to file

Parameters

filename_base	base name for file write
solution	bundled solution data
meta	additional metadata to be written to file

Implemented in VTKIO::VTKGateway.

writeSolution() [4/4]

virtual void Controller::Gateway::writeSolution ( std::string  filename_base, std::shared_ptr< PanNDE::FieldBundle >  solution, std::shared_ptr< PanNDE::DataBundle< double >>  meta, int  write_index  )

pure virtual

write solution variables to file

Parameters

filename_base	base name for file write
solution	bundled solution data
meta	additional metadata to be written to file
write_index	time index to be written

Implemented in VTKIO::VTKGateway.

---

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

• modules/Controller/include/Gateway.hpp