1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkConduitSource
* @brief data source for Conduit Mesh Blueprint.
* @ingroup Insitu
*
* vtkConduitSource is a data source that processes a Conduit node
* using [Conduit Mesh
* Blueprint](https://llnl-conduit.readthedocs.io/en/latest/blueprint_mesh.html#)
* to describe computational mesh and associated meta-data.
*
* vtkConduitSource currently produces a `vtkParitionedDataSet` or
* `vtkPartitionedDataSetCollection`
*
* @sa vtkConduitArrayUtilities
*/
#ifndef vtkConduitSource_h
#define vtkConduitSource_h
#include "vtkDataObjectAlgorithm.h"
#include "vtkIOCatalystConduitModule.h" // for exports
#include "conduit.h" // for conduit_node
#include <memory> // for std::unique_ptr
VTK_ABI_NAMESPACE_BEGIN
class VTKIOCATALYSTCONDUIT_EXPORT vtkConduitSource : public vtkDataObjectAlgorithm
{
public:
static vtkConduitSource* New();
vtkTypeMacro(vtkConduitSource, vtkDataObjectAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* vtkConduitSource supports single 'mesh' and multiple 'mesh' (aka 'multimesh')
* as well as AMR mesh (aka 'amrmesh') protocols.
* Set this to true if the source is handling amrmesh (default is false).
*/
vtkSetMacro(UseAMRMeshProtocol, bool);
vtkGetMacro(UseAMRMeshProtocol, bool);
vtkBooleanMacro(UseAMRMeshProtocol, bool);
///@}
///@{
/**
* vtkConduitSource supports single 'mesh' and multiple 'mesh' (aka 'multimesh')
* as well as AMR mesh (aka 'amrmesh') protocols.
* Set this to true if the source is handling multimesh (default is false).
*/
vtkSetMacro(UseMultiMeshProtocol, bool);
vtkGetMacro(UseMultiMeshProtocol, bool);
vtkBooleanMacro(UseMultiMeshProtocol, bool);
///@}
///@{
/**
* vtkConduitSource supports output vtkMultiBlock instead of vtkPartitionedDataSetCollection
* Set this to true if the source should output vtkMultiBlock (default is false).
*/
vtkSetMacro(OutputMultiBlock, bool);
vtkGetMacro(OutputMultiBlock, bool);
vtkBooleanMacro(OutputMultiBlock, bool);
///@}
///@{
/**
* Get/Set the conduit_node. This must be the node satisfying the Conduit Mesh
* Blueprint.
*/
void SetNode(const conduit_node* node);
///@}
///@{
/**
* Mechanism to add global / field-data arrays.
*
* This is currently experimental and expected to change. It is experimental
* since it's unclear to the developer if Conduit Blueprint already supports
* specifying global fields i.e. without any association. Doesn't look like
* it, but if it does, this should be changed to directly leverage that.
*/
void SetGlobalFieldsNode(const conduit_node* node);
///@}
///@{
/**
* Set the node to read the assembly information from, if any.
*/
void SetAssemblyNode(const conduit_node* node);
///@}
protected:
vtkConduitSource();
~vtkConduitSource() override;
int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector) override;
///@{
/**
* Generate actual output and fill the given data object with it.
* Return true if data is correctly generated.
*/
bool GenerateAMR(vtkDataObject* output);
bool GeneratePartitionedDataSet(vtkDataObject* output);
bool GeneratePartitionedDataSetCollection(vtkDataObject* output);
///@}
private:
vtkConduitSource(const vtkConduitSource&) = delete;
void operator=(const vtkConduitSource&) = delete;
class vtkInternals;
std::unique_ptr<vtkInternals> Internals;
bool UseAMRMeshProtocol;
bool UseMultiMeshProtocol;
bool OutputMultiBlock;
};
VTK_ABI_NAMESPACE_END
#endif
|