MeshLib::VtkMappedMeshSource Class Reference

Detailed Description

VtkMappedMeshSource is a source class to transform OGS meshes into complete vtkUnstructuredGrids. Usage:

vtkNew<MeshLib::VtkMappedMeshSource> vtkSource;
vtkSource->SetMesh(mesh);
vtkSource->Update();
vtkUnstructuredGrid* output = vtkSource->GetOutput();

Adapter which maps a MeshLib::Mesh to a vtkUnstructuredGridAlgorithm. Allows for zero-copy access of the mesh from the visualization side.

Definition at line 34 of file VtkMappedMeshSource.h.

#include <VtkMappedMeshSource.h>

Inheritance diagram for MeshLib::VtkMappedMeshSource:

Collaboration diagram for MeshLib::VtkMappedMeshSource:

Public Member Functions
	vtkTypeMacro (VtkMappedMeshSource, vtkUnstructuredGridAlgorithm)
void	PrintSelf (std::ostream &os, vtkIndent indent) override
	VtkMappedMeshSource (const VtkMappedMeshSource &)=delete
void	operator= (const VtkMappedMeshSource &)=delete
void	SetMesh (const MeshLib::Mesh *mesh)
	Sets the mesh. Calling is mandatory.
const MeshLib::Mesh *	GetMesh () const
	Returns the mesh.

Static Public Member Functions
static VtkMappedMeshSource *	New ()

Protected Member Functions
	VtkMappedMeshSource ()
int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override

Private Member Functions
template<typename T>
void	addProperty (MeshLib::PropertyVector< T > const &property) const
	Adds a zero-copy vtk array wrapper.

Private Attributes
const MeshLib::Mesh *	_mesh {}
int	NumberOfDimensions {0}
int	NumberOfNodes {0}
vtkNew< vtkPoints >	Points
vtkNew< vtkPointData >	PointData
vtkNew< vtkCellData >	CellData
vtkNew< vtkFieldData >	FieldData

Constructor & Destructor Documentation

VtkMappedMeshSource() [1/2]

MeshLib::VtkMappedMeshSource::VtkMappedMeshSource ( const VtkMappedMeshSource & )

delete

References VtkMappedMeshSource().

Referenced by VtkMappedMeshSource(), New(), operator=(), and vtkTypeMacro().

VtkMappedMeshSource() [2/2]

MeshLib::VtkMappedMeshSource::VtkMappedMeshSource ( )

protected

Definition at line 33 of file VtkMappedMeshSource.cpp.

{
    this->SetNumberOfInputPorts(0);
}

Member Function Documentation

addProperty()

template<typename T>

void MeshLib::VtkMappedMeshSource::addProperty ( MeshLib::PropertyVector< T > const & property ) const

private

Adds a zero-copy vtk array wrapper.

Definition at line 217 of file VtkMappedMeshSource.cpp.

{
    vtkNew<vtkAOSDataArrayTemplate<T>> dataArray;
    const bool hasArrayOwnership = false;
    dataArray->SetArray(const_cast<T*>(property.data()),
                        static_cast<vtkIdType>(property.size()),
                        static_cast<int>(!hasArrayOwnership));
    dataArray->SetNumberOfComponents(property.getNumberOfGlobalComponents());
    dataArray->SetName(property.getPropertyName().c_str());
 
    if (property.getMeshItemType() == MeshLib::MeshItemType::Node)
    {
        this->PointData->AddArray(dataArray.GetPointer());
    }
    else if (property.getMeshItemType() == MeshLib::MeshItemType::Cell)
    {
        this->CellData->AddArray(dataArray.GetPointer());
    }
    else if (property.getMeshItemType() ==
             MeshLib::MeshItemType::IntegrationPoint)
    {
        this->FieldData->AddArray(dataArray.GetPointer());
    }
}

References MeshLib::Cell, CellData, MeshLib::PropertyVector< PROP_VAL_TYPE >::data(), FieldData, MeshLib::PropertyVectorBase::getMeshItemType(), MeshLib::PropertyVectorBase::getNumberOfGlobalComponents(), MeshLib::PropertyVectorBase::getPropertyName(), MeshLib::IntegrationPoint, MeshLib::Node, PointData, and MeshLib::PropertyVector< PROP_VAL_TYPE >::size().

Referenced by RequestData().

GetMesh()

const MeshLib::Mesh * MeshLib::VtkMappedMeshSource::GetMesh ( ) const

inline

Returns the mesh.

Definition at line 52 of file VtkMappedMeshSource.h.

{ return _mesh; }

References _mesh.

Referenced by MainWindow::showMeshQualitySelectionDialog().

New()

VtkMappedMeshSource * MeshLib::VtkMappedMeshSource::New ( )

static

References VtkMappedMeshSource().

Referenced by MeshItem::MeshItem().

operator=()

void MeshLib::VtkMappedMeshSource::operator= ( const VtkMappedMeshSource & )

delete

References VtkMappedMeshSource().

PrintSelf()

void MeshLib::VtkMappedMeshSource::PrintSelf ( std::ostream & os, vtkIndent indent )

override

ProcessRequest()

int MeshLib::VtkMappedMeshSource::ProcessRequest ( vtkInformation * request, vtkInformationVector ** inputVector, vtkInformationVector * outputVector )

overrideprotected

Definition at line 39 of file VtkMappedMeshSource.cpp.

{
    if (request->Has(vtkDemandDrivenPipeline::REQUEST_DATA()))
    {
        return this->RequestData(request, inputVector, outputVector);
    }
 
    if (request->Has(vtkDemandDrivenPipeline::REQUEST_INFORMATION()))
    {
        return this->RequestInformation(request, inputVector, outputVector);
    }
 
    return this->Superclass::ProcessRequest(request, inputVector, outputVector);
}

References RequestData(), and RequestInformation().

RequestData()

int MeshLib::VtkMappedMeshSource::RequestData ( vtkInformation * , vtkInformationVector ** , vtkInformationVector * outputVector )

overrideprotected

Definition at line 56 of file VtkMappedMeshSource.cpp.

{
    vtkSmartPointer<vtkInformation> outInfo =
        outputVector->GetInformationObject(0);
    vtkSmartPointer<vtkUnstructuredGrid> output =
        vtkUnstructuredGrid::SafeDownCast(
            outInfo->Get(vtkDataObject::DATA_OBJECT()));
 
    if (outInfo->Get(vtkStreamingDemandDrivenPipeline::UPDATE_PIECE_NUMBER()) >
        0)
    {
        return 1;
    }
 
    // Points
    this->Points->Reset();
 
    MeshNodalCoordinatesBackend backend(_mesh->getNodes());
 
    vtkNew<vtkImplicitArray<MeshNodalCoordinatesBackend>> nodeCoords;
    nodeCoords->ConstructBackend(backend);
    nodeCoords->SetNumberOfComponents(3);
    nodeCoords->SetNumberOfTuples(_mesh->getNumberOfNodes());
    this->Points->SetData(nodeCoords);
    output->SetPoints(this->Points.GetPointer());
 
    // Cells
    auto elems = _mesh->getElements();
    output->Allocate(elems.size());
    for (auto& cell : elems)
    {
        auto cellType = OGSToVtkCellType(cell->getCellType());
 
        const MeshLib::Element* const elem = cell;
        const unsigned numNodes(elem->getNumberOfNodes());
        const MeshLib::Node* const* nodes = cell->getNodes();
        vtkSmartPointer<vtkIdList> ptIds = vtkSmartPointer<vtkIdList>::New();
        ptIds->SetNumberOfIds(numNodes);
 
        for (unsigned i = 0; i < numNodes; ++i)
        {
            ptIds->SetId(i, nodes[i]->getID());
        }
 
        if (cellType == VTK_WEDGE)
        {
            for (unsigned i = 0; i < 3; ++i)
            {
                const auto prism_swap_id = ptIds->GetId(i);
                ptIds->SetId(i, ptIds->GetId(i + 3));
                ptIds->SetId(i + 3, prism_swap_id);
            }
        }
 
        output->InsertNextCell(cellType, ptIds);
    }
 
    // Arrays
    for (auto [name, property] : _mesh->getProperties())
    {
        if (!property->is_for_output)
        {
            continue;
        }
        if (auto const* p = dynamic_cast<PropertyVector<double>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p = dynamic_cast<PropertyVector<float>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p = dynamic_cast<PropertyVector<int>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<unsigned>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p = dynamic_cast<PropertyVector<long>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<long long>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<unsigned long>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<unsigned long long>*>(
                         property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<std::size_t>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p = dynamic_cast<PropertyVector<char>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<unsigned char>*>(property))
        {
            addProperty(*p);
        }
        else if (auto const* p =
                     dynamic_cast<PropertyVector<uint8_t>*>(property))
        {
            addProperty(*p);
        }
        else
        {
            OGS_FATAL(
                "Mesh property '{:s}' of unhandled data type '{:s}'. Please "
                "check the data type of the mesh properties. The available "
                "data types are:"
                "\n\t double,"
                "\n\t float,"
                "\n\t int,"
                "\n\t unsigned,"
                "\n\t long,"
                "\n\t long long,"
                "\n\t unsigned long long,"
                "\n\t char,",
                "\n\t unsigned char,",
                "\n\t uint8_t.",
                property->getPropertyName(),
                BaseLib::typeToString(*property));
        }
    }
 
    output->GetPointData()->ShallowCopy(this->PointData.GetPointer());
    output->GetCellData()->ShallowCopy(this->CellData.GetPointer());
    output->GetFieldData()->ShallowCopy(this->FieldData.GetPointer());
    return 1;
}

References _mesh, addProperty(), CellData, FieldData, MeshLib::Element::getNumberOfNodes(), OGS_FATAL, OGSToVtkCellType(), PointData, Points, and BaseLib::typeToString().

Referenced by ProcessRequest().

RequestInformation()

int MeshLib::VtkMappedMeshSource::RequestInformation ( vtkInformation * , vtkInformationVector ** , vtkInformationVector *  )

overrideprotected

Definition at line 205 of file VtkMappedMeshSource.cpp.

{
    this->NumberOfDimensions = 3;
    this->NumberOfNodes = _mesh->getNumberOfNodes();
 
    return 1;
}

References _mesh, NumberOfDimensions, and NumberOfNodes.

Referenced by ProcessRequest().

SetMesh()

void MeshLib::VtkMappedMeshSource::SetMesh ( const MeshLib::Mesh * mesh )

inline

Sets the mesh. Calling is mandatory.

Definition at line 45 of file VtkMappedMeshSource.h.

    {
        this->_mesh = mesh;
        this->Modified();
    }

References _mesh.

vtkTypeMacro()

MeshLib::VtkMappedMeshSource::vtkTypeMacro	(	VtkMappedMeshSource	,
		vtkUnstructuredGridAlgorithm	)

References VtkMappedMeshSource().

Member Data Documentation

_mesh

const MeshLib::Mesh* MeshLib::VtkMappedMeshSource::_mesh {}

private

Definition at line 72 of file VtkMappedMeshSource.h.

{};

Referenced by GetMesh(), RequestData(), RequestInformation(), SetMesh(), and MeshLib::vtkStandardNewMacro().

CellData

vtkNew<vtkCellData> MeshLib::VtkMappedMeshSource::CellData

private

Definition at line 79 of file VtkMappedMeshSource.h.

Referenced by addProperty(), and RequestData().

FieldData

vtkNew<vtkFieldData> MeshLib::VtkMappedMeshSource::FieldData

private

Definition at line 80 of file VtkMappedMeshSource.h.

Referenced by addProperty(), and RequestData().

NumberOfDimensions

int MeshLib::VtkMappedMeshSource::NumberOfDimensions {0}

private

Definition at line 74 of file VtkMappedMeshSource.h.

{0};

Referenced by RequestInformation().

NumberOfNodes

int MeshLib::VtkMappedMeshSource::NumberOfNodes {0}

private

Definition at line 75 of file VtkMappedMeshSource.h.

{0};

Referenced by RequestInformation().

PointData

vtkNew<vtkPointData> MeshLib::VtkMappedMeshSource::PointData

private

Definition at line 78 of file VtkMappedMeshSource.h.

Referenced by addProperty(), and RequestData().

Points

vtkNew<vtkPoints> MeshLib::VtkMappedMeshSource::Points

private

Definition at line 77 of file VtkMappedMeshSource.h.

Referenced by RequestData().

---

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

• VtkMappedMeshSource.h
• VtkMappedMeshSource.cpp