Public Types | Public Member Functions | List of all members
Opm::BaseOutputWriter Class Referenceabstract

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

#include <baseoutputwriter.hh>

Inheritance diagram for Opm::BaseOutputWriter:
Inheritance graph

Public Types

using Scalar = double
 
using Vector = Dune::DynamicVector< double >
 
using Tensor = Dune::DynamicMatrix< double >
 
using ScalarBuffer = std::vector< Scalar >
 
using VectorBuffer = std::vector< Vector >
 
using TensorBuffer = std::vector< Tensor >
 

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

◆ Scalar

using Opm::BaseOutputWriter::Scalar = double

◆ ScalarBuffer

using Opm::BaseOutputWriter::ScalarBuffer = std::vector<Scalar>

◆ Tensor

using Opm::BaseOutputWriter::Tensor = Dune::DynamicMatrix<double>

◆ TensorBuffer

using Opm::BaseOutputWriter::TensorBuffer = std::vector<Tensor>

◆ Vector

using Opm::BaseOutputWriter::Vector = Dune::DynamicVector<double>

◆ VectorBuffer

using Opm::BaseOutputWriter::VectorBuffer = std::vector<Vector>

Constructor & Destructor Documentation

◆ BaseOutputWriter()

Opm::BaseOutputWriter::BaseOutputWriter ( )
inline

◆ ~BaseOutputWriter()

virtual Opm::BaseOutputWriter::~BaseOutputWriter ( )
inlinevirtual

Member Function Documentation

◆ attachScalarElementData()

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

Add a scalar element centered quantity to the output.

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

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

◆ attachScalarVertexData()

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

Add a scalar vertex centered vector field to the output.

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

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

◆ attachTensorElementData()

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

Add a tensorial element centered quantity to the output.

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

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

◆ attachTensorVertexData()

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

Add a tensorial vertex centered tensor field to the output.

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

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

◆ attachVectorElementData()

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

Add a vectorial element centered quantity to the output.

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

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

◆ attachVectorVertexData()

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

Add a vectorial vertex centered vector field to the output.

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

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

◆ beginWrite()

virtual void Opm::BaseOutputWriter::beginWrite ( double  t)
pure virtual

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

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

◆ endWrite()

virtual void Opm::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 Opm::VtkMultiWriter< GridView, vtkFormat >.

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