Ewoms::BaseOutputWriter Class Reference

The base class for all output writers. More...

#include <baseoutputwriter.hh>

Inheritance diagram for Ewoms::BaseOutputWriter:

Public Types
typedef double	Scalar
typedef Dune::DynamicVector < double >	Vector
typedef Dune::DynamicMatrix < double >	Tensor
typedef std::vector< Scalar >	ScalarBuffer
typedef std::vector< Vector >	VectorBuffer
typedef std::vector< Tensor >	TensorBuffer

Public Member Functions
	BaseOutputWriter ()
virtual	~BaseOutputWriter ()
virtual void	beginWrite (double t)=0
	Called when ever a new time step or a new grid must be written. More...
virtual void	attachScalarVertexData (ScalarBuffer &buf, std::string name)=0
	Add a scalar vertex centered vector field to the output. More...
virtual void	attachScalarElementData (ScalarBuffer &buf, std::string name)=0
	Add a scalar element centered quantity to the output. More...
virtual void	attachVectorVertexData (VectorBuffer &buf, std::string name)=0
	Add a vectorial vertex centered vector field to the output. More...
virtual void	attachVectorElementData (VectorBuffer &buf, std::string name)=0
	Add a vectorial element centered quantity to the output. More...
virtual void	attachTensorVertexData (TensorBuffer &buf, std::string name)=0
	Add a tensorial vertex centered tensor field to the output. More...
virtual void	attachTensorElementData (TensorBuffer &buf, std::string name)=0
	Add a tensorial element centered quantity to the output. More...
virtual void	endWrite (bool onlyDiscard=false)=0
	Finalizes the current writer. More...

Detailed Description

The base class for all output writers.

The sole purpose of this class is to enable RTTI (i.e. dynamic_cast) on writer objects.

Member Typedef Documentation

typedef double Ewoms::BaseOutputWriter::Scalar

typedef std::vector<Scalar> Ewoms::BaseOutputWriter::ScalarBuffer

typedef Dune::DynamicMatrix<double> Ewoms::BaseOutputWriter::Tensor

typedef std::vector<Tensor> Ewoms::BaseOutputWriter::TensorBuffer

typedef Dune::DynamicVector<double> Ewoms::BaseOutputWriter::Vector

typedef std::vector<Vector> Ewoms::BaseOutputWriter::VectorBuffer

Constructor & Destructor Documentation

Ewoms::BaseOutputWriter::BaseOutputWriter ( )

inline

virtual Ewoms::BaseOutputWriter::~BaseOutputWriter ( )

inlinevirtual

Member Function Documentation

virtual void Ewoms::BaseOutputWriter::attachScalarElementData ( ScalarBuffer &  buf, std::string  name  )

pure virtual

Add a scalar element centered quantity to the output.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

Referenced by Ewoms::EcfvBaseOutputModule< TypeTag >::attachScalarDofData_(), and Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_().

virtual void Ewoms::BaseOutputWriter::attachScalarVertexData ( ScalarBuffer &  buf, std::string  name  )

pure virtual

Add a scalar vertex centered vector field to the output.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

Referenced by Ewoms::VcfvBaseOutputModule< TypeTag >::attachScalarDofData_(), and Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_().

virtual void Ewoms::BaseOutputWriter::attachTensorElementData ( TensorBuffer &  buf, std::string  name  )

pure virtual

Add a tensorial element centered quantity to the output.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

Referenced by Ewoms::EcfvBaseOutputModule< TypeTag >::attachTensorDofData_(), and Ewoms::BaseOutputModule< TypeTag >::attachTensorElementData_().

virtual void Ewoms::BaseOutputWriter::attachTensorVertexData ( TensorBuffer &  buf, std::string  name  )

pure virtual

Add a tensorial vertex centered tensor field to the output.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

Referenced by Ewoms::VcfvBaseOutputModule< TypeTag >::attachTensorDofData_(), and Ewoms::BaseOutputModule< TypeTag >::attachTensorVertexData_().

virtual void Ewoms::BaseOutputWriter::attachVectorElementData ( VectorBuffer &  buf, std::string  name  )

pure virtual

Add a vectorial element centered quantity to the output.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

Referenced by Ewoms::EcfvBaseOutputModule< TypeTag >::attachVectorDofData_(), and Ewoms::BaseOutputModule< TypeTag >::attachVectorElementData_().

virtual void Ewoms::BaseOutputWriter::attachVectorVertexData ( VectorBuffer &  buf, std::string  name  )

pure virtual

Add a vectorial vertex centered vector field to the output.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

Referenced by Ewoms::VcfvBaseOutputModule< TypeTag >::attachVectorDofData_(), and Ewoms::BaseOutputModule< TypeTag >::attachVectorVertexData_().

virtual void Ewoms::BaseOutputWriter::beginWrite ( double  t )

pure virtual

Called when ever a new time step or a new grid must be written.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

virtual void Ewoms::BaseOutputWriter::endWrite ( bool  onlyDiscard = false )

pure virtual

Finalizes the current writer.

This means that everything will be written to disk, except if the onlyDiscard argument is true. In this case only all managed buffers are deleted, but no output is written.

Implemented in Ewoms::VtkMultiWriter< GridView, vtkFormat >.

---

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

• baseoutputwriter.hh