Ewoms::VtkEnergyModule< TypeTag > Class Template Reference

VTK output module for quantities which make sense for models which assume thermal equilibrium. More...

#include <vtkenergymodule.hh>

Inheritance diagram for Ewoms::VtkEnergyModule< TypeTag >:
Ewoms::BaseOutputModule< TypeTag >

Public Member Functions

 VtkEnergyModule (const Simulator &simulator)
 
void allocBuffers ()
 Allocate memory for the scalar fields we would like to write to the VTK file.
 
void processElement (const ElementContext &elemCtx)
 Modify the internal buffers according to the intensive quanties relevant for an element.
 
void commitBuffers (BaseOutputWriter &baseWriter)
 Add all buffers to the VTK output writer.
 
- Public Member Functions inherited from Ewoms::BaseOutputModule< TypeTag >
 BaseOutputModule (const Simulator &simulator)
 
virtual bool needExtensiveQuantities () const
 Returns true iff the module needs to access the extensive quantities of a context to do its job. More...
 

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the Vtk output module.
 

Additional Inherited Members

- Public Types inherited from Ewoms::BaseOutputModule< TypeTag >
typedef BaseOutputWriter::ScalarBuffer ScalarBuffer
 
typedef BaseOutputWriter::VectorBuffer VectorBuffer
 
typedef BaseOutputWriter::TensorBuffer TensorBuffer
 
typedef std::array< ScalarBuffer, numEq > EqBuffer
 
typedef std::array< ScalarBuffer, numPhases > PhaseBuffer
 
typedef std::array< ScalarBuffer, numComponents > ComponentBuffer
 
typedef std::array< std::array< ScalarBuffer, numComponents >, numPhases > PhaseComponentBuffer
 
typedef std::array< VectorBuffer, numPhases > PhaseVectorBuffer
 
- Protected Types inherited from Ewoms::BaseOutputModule< TypeTag >
enum  BufferType { DofBuffer, VertexBuffer, ElementBuffer }
 
- Protected Member Functions inherited from Ewoms::BaseOutputModule< TypeTag >
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 inherited from Ewoms::BaseOutputModule< TypeTag >
const Simulatorsimulator_
 

Detailed Description

template<class TypeTag>
class Ewoms::VtkEnergyModule< TypeTag >

VTK output module for quantities which make sense for models which assume thermal equilibrium.

This module deals with the following quantities:

  • Specific enthalpy of all fluid phases
  • Specific internal energy of all fluid phases
  • Specific heat capacity of the solid phase
  • Lumped heat conductivity (solid phase plus all fluid phases)

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