The base class for writer modules. More...
#include <baseoutputmodule.hh>
Public Member Functions | |
BaseOutputModule (const Simulator &simulator) | |
virtual void | allocBuffers ()=0 |
Allocate memory for the scalar fields we would like to write to disk. More... | |
virtual void | processElement (const ElementContext &elemCtx)=0 |
Modify the internal buffers according to the intensive quanties relevant for an element. More... | |
virtual void | commitBuffers (BaseOutputWriter &writer)=0 |
Add all buffers to the VTK output writer. | |
virtual bool | needExtensiveQuantities () const |
Returns true iff the module needs to access the extensive quantities of a context to do its job. More... | |
Protected Types | |
enum | BufferType { DofBuffer, VertexBuffer, ElementBuffer } |
Protected Member Functions | |
void | resizeScalarBuffer_ (ScalarBuffer &buffer, BufferType bufferType=DofBuffer) |
Allocate the space for a buffer storing a scalar quantity. | |
void | resizeTensorBuffer_ (TensorBuffer &buffer, BufferType bufferType=DofBuffer) |
Allocate the space for a buffer storing a tensorial quantity. | |
void | resizeEqBuffer_ (EqBuffer &buffer, BufferType bufferType=DofBuffer) |
Allocate the space for a buffer storing a equation specific quantity. | |
void | resizePhaseBuffer_ (PhaseBuffer &buffer, BufferType bufferType=DofBuffer) |
Allocate the space for a buffer storing a phase-specific quantity. | |
void | resizeComponentBuffer_ (ComponentBuffer &buffer, BufferType bufferType=DofBuffer) |
Allocate the space for a buffer storing a component specific quantity. | |
void | resizePhaseComponentBuffer_ (PhaseComponentBuffer &buffer, BufferType bufferType=DofBuffer) |
Allocate the space for a buffer storing a phase and component specific buffer. | |
void | commitScalarBuffer_ (BaseOutputWriter &baseWriter, const char *name, ScalarBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a buffer containing scalar quantities to the result file. | |
void | commitVectorBuffer_ (BaseOutputWriter &baseWriter, const char *name, VectorBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a buffer containing vectorial quantities to the result file. | |
void | commitTensorBuffer_ (BaseOutputWriter &baseWriter, const char *name, TensorBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a buffer containing tensorial quantities to the result file. | |
void | commitPriVarsBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, EqBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a buffer with as many variables as PDEs to the result file. | |
void | commitEqBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, EqBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a buffer with as many variables as PDEs to the result file. | |
void | commitPhaseBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, PhaseBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a phase-specific buffer to the result file. | |
void | commitComponentBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, ComponentBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a component-specific buffer to the result file. | |
void | commitPhaseComponentBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, PhaseComponentBuffer &buffer, BufferType bufferType=DofBuffer) |
Add a phase and component specific quantities to the output. | |
void | attachScalarElementData_ (BaseOutputWriter &baseWriter, ScalarBuffer &buffer, const char *name) |
void | attachScalarVertexData_ (BaseOutputWriter &baseWriter, ScalarBuffer &buffer, const char *name) |
void | attachVectorElementData_ (BaseOutputWriter &baseWriter, VectorBuffer &buffer, const char *name) |
void | attachVectorVertexData_ (BaseOutputWriter &baseWriter, VectorBuffer &buffer, const char *name) |
void | attachTensorElementData_ (BaseOutputWriter &baseWriter, TensorBuffer &buffer, const char *name) |
void | attachTensorVertexData_ (BaseOutputWriter &baseWriter, TensorBuffer &buffer, const char *name) |
Protected Attributes | |
const Simulator & | simulator_ |
The base class for writer modules.
This class also provides some convenience methods for buffer management and is the base class for all other output writer modules.
|
protected |
|
pure virtual |
Allocate memory for the scalar fields we would like to write to disk.
The module can dynamically cast the writer to the desired concrete class. If the writer is incompatible with the module, this method should become a no-op.
Implemented in Ewoms::VtkBlackOilModule< TypeTag >, Ewoms::VtkMultiPhaseModule< TypeTag >, Ewoms::VtkDiscreteFractureModule< TypeTag >, Ewoms::VtkBlackOilPolymerModule< TypeTag >, Ewoms::VtkCompositionModule< TypeTag >, Ewoms::VtkEnergyModule< TypeTag >, Ewoms::VtkBlackOilSolventModule< TypeTag >, Ewoms::VtkDiffusionModule< TypeTag >, Ewoms::VtkPrimaryVarsModule< TypeTag >, Ewoms::VtkTemperatureModule< TypeTag >, and Ewoms::VtkPhasePresenceModule< TypeTag >.
|
inlinevirtual |
Returns true iff the module needs to access the extensive quantities of a context to do its job.
For example, this happens if velocities or gradients should be written.
Always returning true here does not do any harm from the correctness perspective, but it slows down writing the output fields. Since most output modules only write intensive quantities, this method returns 'false' by default.
Reimplemented in Ewoms::VtkMultiPhaseModule< TypeTag >.
|
pure virtual |
Modify the internal buffers according to the intensive quanties relevant for an element.
The module can dynamically cast the writer to the desired concrete class. If the writer is incompatible with the module, this method should become a no-op.
Implemented in Ewoms::VtkMultiPhaseModule< TypeTag >, Ewoms::VtkBlackOilModule< TypeTag >, Ewoms::VtkDiscreteFractureModule< TypeTag >, Ewoms::VtkBlackOilPolymerModule< TypeTag >, Ewoms::VtkCompositionModule< TypeTag >, Ewoms::VtkBlackOilSolventModule< TypeTag >, Ewoms::VtkEnergyModule< TypeTag >, Ewoms::VtkDiffusionModule< TypeTag >, Ewoms::VtkPrimaryVarsModule< TypeTag >, Ewoms::VtkTemperatureModule< TypeTag >, and Ewoms::VtkPhasePresenceModule< TypeTag >.