bdm::ParaviewAdaptor Class Reference

The class that bridges the simulation code with ParaView. More...

#include <adaptor.h>

Inheritance diagram for bdm::ParaviewAdaptor:

Collaboration diagram for bdm::ParaviewAdaptor:

Classes
struct	ParaviewImpl

Public Member Functions
	ParaviewAdaptor ()
	~ParaviewAdaptor () override
void	Visualize () override
	Visualize one timestep based on the configuration in Param More...

Private Member Functions
void	Initialize ()
void	InsituVisualization ()
	Execute the insitu pipelines that were defined in Initialize More...
void	ExportVisualization ()
void	CreateVtkObjects ()
	Creates the VTK objects that represent the agents in ParaView. More...
void	BuildAgentsVTKStructures ()
	Create the required vtk objects to visualize agents. More...
void	BuildDiffusionGridVTKStructures ()
	Create the required vtk objects to visualize diffusion grids. More...
void	WriteSimulationInfoJsonFile ()
	ClassDefNV (ParaviewAdaptor, 1)
Private Member Functions inherited from bdm::VisualizationAdaptor
	VisualizationAdaptor ()=default
virtual	~VisualizationAdaptor ()=default

Static Private Member Functions
static void	GenerateParaviewState ()
static std::string	BuildPythonScriptString (const std::string &python_script)
Static Private Member Functions inherited from bdm::VisualizationAdaptor
static VisualizationAdaptor *	Create (const std::string &adaptor)

Private Attributes
std::unique_ptr< ParaviewImpl >	impl_
bool	initialized_ = false
	only needed for insitu visualization More...
bool	simulation_info_json_generated_ = false

Static Private Attributes
static std::atomic< uint64_t >	counter_

Friends
class	ParaviewAdaptorTest_GenerateSimulationInfoJson_Test
class	ParaviewAdaptorTest_GenerateParaviewState_Test
class	ParaviewAdaptorTest_DISABLED_CheckVisualizationSelection_Test
class	DISABLED_DiffusionTest_ModelInitializer_Test

Detailed Description

The class that bridges the simulation code with ParaView.

Definition at line 39 of file adaptor.h.

Constructor & Destructor Documentation

ParaviewAdaptor()

bdm::ParaviewAdaptor::ParaviewAdaptor

(

)

Initializes Catalyst with the predefined pipeline and allocates memory for the VTK grid structures

Definition at line 61 of file adaptor.cc.

~ParaviewAdaptor()

bdm::ParaviewAdaptor::~ParaviewAdaptor ( )

override

Definition at line 68 of file adaptor.cc.

Member Function Documentation

BuildAgentsVTKStructures()

void bdm::ParaviewAdaptor::BuildAgentsVTKStructures ( )

private

Create the required vtk objects to visualize agents.

Definition at line 214 of file adaptor.cc.

BuildDiffusionGridVTKStructures()

void bdm::ParaviewAdaptor::BuildDiffusionGridVTKStructures ( )

private

Create the required vtk objects to visualize diffusion grids.

Definition at line 223 of file adaptor.cc.

BuildPythonScriptString()

std::string bdm::ParaviewAdaptor::BuildPythonScriptString ( const std::string &  python_script )

staticprivate

Combine user-defined python script with biodynamo default python insitu pipeline.

Definition at line 269 of file adaptor.cc.

ClassDefNV()

bdm::ParaviewAdaptor::ClassDefNV ( ParaviewAdaptor  , 1    )

private

CreateVtkObjects()

void bdm::ParaviewAdaptor::CreateVtkObjects ( )

private

Creates the VTK objects that represent the agents in ParaView.

Definition at line 199 of file adaptor.cc.

ExportVisualization()

void bdm::ParaviewAdaptor::ExportVisualization ( )

private

Exports the visualized objects to file, so that they can be imported and visualized in ParaView at a later point in time

Definition at line 184 of file adaptor.cc.

GenerateParaviewState()

void bdm::ParaviewAdaptor::GenerateParaviewState ( )

staticprivate

This function generates the Paraview state based on the exported files Therefore, the user can load the visualization simply by opening the pvsm file and does not have to perform a lot of manual steps.

Definition at line 251 of file adaptor.cc.

Initialize()

void bdm::ParaviewAdaptor::Initialize ( )

private

Parameters might be set after the constructor has been called. Therefore, we defer initialization to the first invocation of Visualize.

Definition at line 125 of file adaptor.cc.

InsituVisualization()

void bdm::ParaviewAdaptor::InsituVisualization ( )

private

Execute the insitu pipelines that were defined in Initialize

Definition at line 173 of file adaptor.cc.

Visualize()

void bdm::ParaviewAdaptor::Visualize ( )

overridevirtual

Visualize one timestep based on the configuration in Param

Implements bdm::VisualizationAdaptor.

Definition at line 98 of file adaptor.cc.

WriteSimulationInfoJsonFile()

void bdm::ParaviewAdaptor::WriteSimulationInfoJsonFile ( )

private

Definition at line 235 of file adaptor.cc.

Friends And Related Function Documentation

DISABLED_DiffusionTest_ModelInitializer_Test

friend class DISABLED_DiffusionTest_ModelInitializer_Test

friend

Definition at line 63 of file adaptor.h.

ParaviewAdaptorTest_DISABLED_CheckVisualizationSelection_Test

friend class ParaviewAdaptorTest_DISABLED_CheckVisualizationSelection_Test

friend

Definition at line 62 of file adaptor.h.

ParaviewAdaptorTest_GenerateParaviewState_Test

friend class ParaviewAdaptorTest_GenerateParaviewState_Test

friend

Definition at line 61 of file adaptor.h.

ParaviewAdaptorTest_GenerateSimulationInfoJson_Test

friend class ParaviewAdaptorTest_GenerateSimulationInfoJson_Test

friend

Definition at line 60 of file adaptor.h.

Member Data Documentation

counter_

std::atomic< uint64_t > bdm::ParaviewAdaptor::counter_

staticprivate

Definition at line 54 of file adaptor.h.

impl_

std::unique_ptr<ParaviewImpl> bdm::ParaviewAdaptor::impl_

private

Definition at line 50 of file adaptor.h.

initialized_

bool bdm::ParaviewAdaptor::initialized_ = false

private

only needed for insitu visualization

Definition at line 57 of file adaptor.h.

simulation_info_json_generated_

bool bdm::ParaviewAdaptor::simulation_info_json_generated_ = false

private

Definition at line 58 of file adaptor.h.

---

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

• core/visualization/paraview/adaptor.h
• core/visualization/paraview/adaptor.cc