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

#include <vtkenergymodule.hh>

Inheritance diagram for Ewoms::VtkEnergyModule< TypeTag >:

Public Types
typedef BaseOutputWriter::VectorBuffer	VectorBuffer

typedef BaseOutputWriter::TensorBuffer	TensorBuffer

typedef std::array < ScalarBuffer, numEq >	EqBuffer

typedef std::array < ScalarBuffer, numComponents >	ComponentBuffer

typedef std::array< std::array < ScalarBuffer, numComponents > , numPhases >	PhaseComponentBuffer

typedef std::array < VectorBuffer, numPhases >	PhaseVectorBuffer

Public Member Functions
	VtkEnergyModule (const Simulator &simulator)

void	allocBuffers ()
	Allocate memory for the scalar fields we would like to write to the VTK file. More...

void	processElement (const ElementContext &elemCtx)
	Modify the internal buffers according to the intensive quanties relevant for an element. More...

void	commitBuffers (BaseOutputWriter &baseWriter)
	Add all buffers to the VTK output writer. More...

Static Public Member Functions
static void	registerParameters ()
	Register all run-time parameters for the Vtk output module. 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. More...

void	resizeTensorBuffer_ (TensorBuffer &buffer, BufferType bufferType=DofBuffer)
	Allocate the space for a buffer storing a tensorial quantity. More...

void	resizeEqBuffer_ (EqBuffer &buffer, BufferType bufferType=DofBuffer)
	Allocate the space for a buffer storing a equation specific quantity. More...

void	resizePhaseBuffer_ (PhaseBuffer &buffer, BufferType bufferType=DofBuffer)
	Allocate the space for a buffer storing a phase-specific quantity. More...

void	resizeComponentBuffer_ (ComponentBuffer &buffer, BufferType bufferType=DofBuffer)
	Allocate the space for a buffer storing a component specific quantity. More...

void	resizePhaseComponentBuffer_ (PhaseComponentBuffer &buffer, BufferType bufferType=DofBuffer)
	Allocate the space for a buffer storing a phase and component specific buffer. More...

void	commitScalarBuffer_ (BaseOutputWriter &baseWriter, const char *name, ScalarBuffer &buffer, BufferType bufferType=DofBuffer)
	Add a buffer containing scalar quantities to the result file. More...

void	commitVectorBuffer_ (BaseOutputWriter &baseWriter, const char *name, VectorBuffer &buffer, BufferType bufferType=DofBuffer)
	Add a buffer containing vectorial quantities to the result file. More...

void	commitTensorBuffer_ (BaseOutputWriter &baseWriter, const char *name, TensorBuffer &buffer, BufferType bufferType=DofBuffer)
	Add a buffer containing tensorial quantities to the result file. More...

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. More...

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. More...

void	commitPhaseBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, PhaseBuffer &buffer, BufferType bufferType=DofBuffer)
	Add a phase-specific buffer to the result file. More...

void	commitComponentBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, ComponentBuffer &buffer, BufferType bufferType=DofBuffer)
	Add a component-specific buffer to the result file. More...

void	commitPhaseComponentBuffer_ (BaseOutputWriter &baseWriter, const char *pattern, PhaseComponentBuffer &buffer, BufferType bufferType=DofBuffer)
	Add a phase and component specific quantities to the output. More...

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_

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)

Member Typedef Documentation

template<class TypeTag>

typedef std::array<ScalarBuffer, numComponents> Ewoms::BaseOutputModule< TypeTag >::ComponentBuffer

inherited

template<class TypeTag>

typedef std::array<ScalarBuffer, numEq> Ewoms::BaseOutputModule< TypeTag >::EqBuffer

inherited

template<class TypeTag>

typedef std::array<std::array<ScalarBuffer, numComponents>, numPhases> Ewoms::BaseOutputModule< TypeTag >::PhaseComponentBuffer

inherited

template<class TypeTag>

typedef std::array<VectorBuffer, numPhases> Ewoms::BaseOutputModule< TypeTag >::PhaseVectorBuffer

inherited

template<class TypeTag>

typedef BaseOutputWriter::TensorBuffer Ewoms::BaseOutputModule< TypeTag >::TensorBuffer

inherited

template<class TypeTag>

typedef BaseOutputWriter::VectorBuffer Ewoms::BaseOutputModule< TypeTag >::VectorBuffer

inherited

Member Enumeration Documentation

template<class TypeTag>

enum Ewoms::BaseOutputModule::BufferType

protectedinherited

Enumerator
DofBuffer	Buffer contains data associated with the degrees of freedom.
VertexBuffer	Buffer contains data associated with the grid's vertices.
ElementBuffer	Buffer contains data associated with the grid's elements.

Constructor & Destructor Documentation

template<class TypeTag >

Ewoms::VtkEnergyModule< TypeTag >::VtkEnergyModule ( const Simulator & simulator )

inline

Member Function Documentation

template<class TypeTag >

void Ewoms::VtkEnergyModule< TypeTag >::allocBuffers ( )

inlinevirtual

Allocate memory for the scalar fields we would like to write to the VTK file.

Implements Ewoms::BaseOutputModule< TypeTag >.

References Ewoms::BaseOutputModule< TypeTag >::resizePhaseBuffer_(), and Ewoms::BaseOutputModule< TypeTag >::resizeScalarBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_	(	BaseOutputWriter &	baseWriter,
		ScalarBuffer &	buffer,
		const char *	name
	)

inlineprotectedinherited

References Ewoms::BaseOutputWriter::attachScalarElementData().

Referenced by Ewoms::BaseOutputModule< TypeTag >::commitComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitEqBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitPhaseBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitPhaseComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitPriVarsBuffer_(), and Ewoms::BaseOutputModule< TypeTag >::commitScalarBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_	(	BaseOutputWriter &	baseWriter,
		ScalarBuffer &	buffer,
		const char *	name
	)

inlineprotectedinherited

References Ewoms::BaseOutputWriter::attachScalarVertexData().

Referenced by Ewoms::BaseOutputModule< TypeTag >::commitComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitEqBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitPhaseBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitPhaseComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::commitPriVarsBuffer_(), and Ewoms::BaseOutputModule< TypeTag >::commitScalarBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::attachTensorElementData_	(	BaseOutputWriter &	baseWriter,
		TensorBuffer &	buffer,
		const char *	name
	)

inlineprotectedinherited

References Ewoms::BaseOutputWriter::attachTensorElementData().

Referenced by Ewoms::BaseOutputModule< TypeTag >::commitTensorBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::attachTensorVertexData_	(	BaseOutputWriter &	baseWriter,
		TensorBuffer &	buffer,
		const char *	name
	)

inlineprotectedinherited

References Ewoms::BaseOutputWriter::attachTensorVertexData().

Referenced by Ewoms::BaseOutputModule< TypeTag >::commitTensorBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::attachVectorElementData_	(	BaseOutputWriter &	baseWriter,
		VectorBuffer &	buffer,
		const char *	name
	)

inlineprotectedinherited

References Ewoms::BaseOutputWriter::attachVectorElementData().

Referenced by Ewoms::BaseOutputModule< TypeTag >::commitVectorBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::attachVectorVertexData_	(	BaseOutputWriter &	baseWriter,
		VectorBuffer &	buffer,
		const char *	name
	)

inlineprotectedinherited

References Ewoms::BaseOutputWriter::attachVectorVertexData().

Referenced by Ewoms::BaseOutputModule< TypeTag >::commitVectorBuffer_().

template<class TypeTag >

void Ewoms::VtkEnergyModule< TypeTag >::commitBuffers ( BaseOutputWriter & baseWriter )

inlinevirtual

Add all buffers to the VTK output writer.

Implements Ewoms::BaseOutputModule< TypeTag >.

References Ewoms::BaseOutputModule< TypeTag >::commitPhaseBuffer_(), and Ewoms::BaseOutputModule< TypeTag >::commitScalarBuffer_().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitComponentBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	pattern,
		ComponentBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a component-specific buffer to the result file.

References Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

Referenced by Ewoms::VtkCompositionModule< TypeTag >::commitBuffers().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitEqBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	pattern,
		EqBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a buffer with as many variables as PDEs to the result file.

References Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitPhaseBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	pattern,
		PhaseBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a phase-specific buffer to the result file.

References Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

Referenced by Ewoms::VtkDiffusionModule< TypeTag >::commitBuffers(), Ewoms::VtkEnergyModule< TypeTag >::commitBuffers(), Ewoms::VtkDiscreteFractureModule< TypeTag >::commitBuffers(), and Ewoms::VtkMultiPhaseModule< TypeTag >::commitBuffers().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitPhaseComponentBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	pattern,
		PhaseComponentBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a phase and component specific quantities to the output.

References Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

Referenced by Ewoms::VtkDiffusionModule< TypeTag >::commitBuffers(), and Ewoms::VtkCompositionModule< TypeTag >::commitBuffers().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitPriVarsBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	pattern,
		EqBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a buffer with as many variables as PDEs to the result file.

References Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, Ewoms::Simulator< TypeTag >::model(), Ewoms::BaseOutputModule< TypeTag >::simulator_, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

Referenced by Ewoms::VtkPrimaryVarsModule< TypeTag >::commitBuffers().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitScalarBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	name,
		ScalarBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a buffer containing scalar quantities to the result file.

References Ewoms::BaseOutputModule< TypeTag >::attachScalarElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachScalarVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

Referenced by Ewoms::VtkPhasePresenceModule< TypeTag >::commitBuffers(), Ewoms::VtkTemperatureModule< TypeTag >::commitBuffers(), Ewoms::VtkPrimaryVarsModule< TypeTag >::commitBuffers(), Ewoms::VtkEnergyModule< TypeTag >::commitBuffers(), Ewoms::VtkBlackOilModule< TypeTag >::commitBuffers(), Ewoms::VtkDiscreteFractureModule< TypeTag >::commitBuffers(), and Ewoms::VtkMultiPhaseModule< TypeTag >::commitBuffers().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitTensorBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	name,
		TensorBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)

inlineprotectedinherited

Add a buffer containing tensorial quantities to the result file.

References Ewoms::BaseOutputModule< TypeTag >::attachTensorElementData_(), Ewoms::BaseOutputModule< TypeTag >::attachTensorVertexData_(), Ewoms::BaseOutputModule< TypeTag >::DofBuffer, Ewoms::BaseOutputModule< TypeTag >::ElementBuffer, and Ewoms::BaseOutputModule< TypeTag >::VertexBuffer.

Referenced by Ewoms::VtkMultiPhaseModule< TypeTag >::commitBuffers().

template<class TypeTag>

void Ewoms::BaseOutputModule< TypeTag >::commitVectorBuffer_	(	BaseOutputWriter &	baseWriter,
		const char *	name,
		VectorBuffer &	buffer,
		BufferType	bufferType = `DofBuffer`
	)