ParaViewModule Class Reference

Module for exporting simulation data to ParaView format. More...

#include "ParaViewModule.h"

Inheritance diagram for ParaViewModule:

Collaboration diagram for ParaViewModule:

Classes
struct	ElementInfo
	Structure containing element group export information. More...

Public Member Functions
	ParaViewModule (const String &name="paraView")
	Constructor.
virtual Status	init (const Properties &conf, const Properties &props, const Properties &globdat) override
	Initialize the module.
virtual Status	run (const Properties &globdat) override
	Run the ParaView export.
virtual void	shutdown (const Properties &globdat) override
	Shutdown and finalize ParaView export.

Static Public Member Functions
static Ref< Module >	makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
	Factory method for creating new ParaViewModule instances.
static void	declare ()
	Register ParaViewModule type with ModuleFactory.
static idx_t	nameToVTKNum (const String &name)
	Convert element shape name to VTK cell type number.
static IdxVector	gmsh2ParaNodeOrder (const IdxVector elNodes, const String &name)
	Convert GMSH node ordering to ParaView node ordering.

Static Public Attributes
Property identifiers
static const char *	TYPE_NAME = "ParaView"
	Module type name.
static const char *	SPACING = " "
	XML indentation spacing.

Detailed Description

This module exports finite element simulation results to VTK/VTU format files for visualization in ParaView. Key features include:

• Multi-group support: Export different element groups with specific data sets
• Time series output: Generate time-dependent visualization files with PVD collection
• Flexible data export: Support for displacements, velocities, accelerations, and custom DOF data
• Element compatibility: Handles various element shapes with proper VTK cell type mapping
• Node ordering: Automatic conversion from GMSH to ParaView node ordering
• Conditional sampling: Configurable output frequency based on time or iteration criteria

The module supports both individual VTU files and ParaView collection (PVD) files for time series visualization. Element and node data can be selectively exported based on configuration, making it suitable for large-scale simulations where storage efficiency is important.

See also

ParaView

VTK file formats

Constructor & Destructor Documentation

ParaViewModule()

ParaViewModule::ParaViewModule ( const String &  name = "paraView" )

explicit

Parameters

name	Module name (default: "paraView")

Member Function Documentation

declare()

void ParaViewModule::declare ( )

static

gmsh2ParaNodeOrder()

IdxVector ParaViewModule::gmsh2ParaNodeOrder ( const IdxVector  elNodes, const String &  name  )

static

Parameters

elNodes	Vector with JIVE node indices
name	Element shape name

Returns

Correctly ordered node vector for ParaView

Different finite element codes use different node ordering conventions. This function converts from GMSH ordering to ParaView ordering

init()

Module::Status ParaViewModule::init ( const Properties &  conf, const Properties &  props, const Properties &  globdat  )

overridevirtual

Parameters

conf	Actually used configuration properties (output)
props	User-specified module properties
globdat	Global data container

Returns

Module status

Configures output format, file type, element groups, data fields, and sampling conditions for ParaView export

makeNew()

Ref< Module > ParaViewModule::makeNew ( const String &  name, const Properties &  conf, const Properties &  props, const Properties &  globdat  )

static

Parameters

name	Module name
conf	Actually used configuration properties (output)
props	User-specified module properties
globdat	Global data container

Returns

Reference to new ParaViewModule instance

nameToVTKNum()

idx_t ParaViewModule::nameToVTKNum ( const String &  name )

static

Parameters

name	Element shape name (e.g., "Triangle", "Tetrahedron")

Returns

VTK cell type identifier

Maps JIVE element shape names to corresponding VTK cell type numbers for proper visualization in ParaView

run()

Module::Status ParaViewModule::run ( const Properties &  globdat )

overridevirtual

Parameters

globdat

Global data container

Returns

Module status

Exports current simulation state to VTU file if sampling conditions are met, and updates PVD collection if enabled

shutdown()

void ParaViewModule::shutdown ( const Properties &  globdat )

overridevirtual

Parameters

globdat

Global data container

Writes final PVD collection file for time series visualization

Member Data Documentation

SPACING

const char * ParaViewModule::SPACING = " "

static

TYPE_NAME

const char * ParaViewModule::TYPE_NAME = "ParaView"

static