preCICE
Loading...
Searching...
No Matches
precice::impl::MeshContext Struct Reference

#include <MeshContext.hpp>

Inheritance diagram for precice::impl::MeshContext:
[legend]
Collaboration diagram for precice::impl::MeshContext:
[legend]

Public Member Functions

void require (mapping::Mapping::MeshRequirement requirement)
void clearMappings ()

Public Attributes

mesh::PtrMesh mesh
 Mesh holding the geometry data structure.
mapping::Mapping::MeshRequirement meshRequirement = mapping::Mapping::MeshRequirement::UNDEFINED
 Determines which mesh type has to be provided by the accessor.
std::vector< MappingContextfromMappingContexts
 Mappings used when mapping data from the mesh. Can be empty.
std::vector< MappingContexttoMappingContexts
 Mappings used when mapping data to the mesh. Can be empty.

Detailed Description

Base class storing common mesh-related objects and data. ProvidedMeshContext and ReceivedMeshContext derive from this.

Definition at line 16 of file MeshContext.hpp.

Member Function Documentation

◆ clearMappings()

void precice::impl::MeshContext::clearMappings ( )
inline

Definition at line 34 of file MeshContext.hpp.

◆ require()

void precice::impl::MeshContext::require ( mapping::Mapping::MeshRequirement requirement)
inline

Upgrades the mesh requirement to a more specific level.

Parameters
[in]requirementThe requirement to upgrade to.

Definition at line 45 of file MeshContext.hpp.

Member Data Documentation

◆ fromMappingContexts

std::vector<MappingContext> precice::impl::MeshContext::fromMappingContexts

Mappings used when mapping data from the mesh. Can be empty.

Definition at line 29 of file MeshContext.hpp.

◆ mesh

mesh::PtrMesh precice::impl::MeshContext::mesh

Mesh holding the geometry data structure.

Definition at line 23 of file MeshContext.hpp.

◆ meshRequirement

Determines which mesh type has to be provided by the accessor.

Definition at line 26 of file MeshContext.hpp.

◆ toMappingContexts

std::vector<MappingContext> precice::impl::MeshContext::toMappingContexts

Mappings used when mapping data to the mesh. Can be empty.

Definition at line 32 of file MeshContext.hpp.


The documentation for this struct was generated from the following file: