preCICE v3.1.2
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
precice::impl::MeshContext Struct Reference

Stores a mesh and related objects and data. More...

#include <MeshContext.hpp>

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::string receiveMeshFrom
 Name of participant that creates the mesh.
 
double safetyFactor = -1
 bounding box to speed up decomposition of received mesh is increased by this safety factor
 
bool allowDirectAccess = false
 
bool provideMesh = false
 True, if accessor does create the mesh.
 
partition::ReceivedPartition::GeometricFilter geoFilter = partition::ReceivedPartition::GeometricFilter::UNDEFINED
 type of geometric filter
 
partition::PtrPartition partition
 Partition creating the parallel decomposition of the mesh.
 
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

Stores a mesh and related objects and data.

Definition at line 16 of file MeshContext.hpp.

Member Function Documentation

◆ clearMappings()

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

Definition at line 53 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 64 of file MeshContext.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ allowDirectAccess

bool precice::impl::MeshContext::allowDirectAccess = false

In case a mapping done by the solver is favored over a preCICE mapping, apply user-defined bounding-boxes.

Definition at line 36 of file MeshContext.hpp.

◆ fromMappingContexts

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

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

Definition at line 48 of file MeshContext.hpp.

◆ geoFilter

type of geometric filter

Definition at line 42 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.

◆ partition

partition::PtrPartition precice::impl::MeshContext::partition

Partition creating the parallel decomposition of the mesh.

Definition at line 45 of file MeshContext.hpp.

◆ provideMesh

bool precice::impl::MeshContext::provideMesh = false

True, if accessor does create the mesh.

Definition at line 39 of file MeshContext.hpp.

◆ receiveMeshFrom

std::string precice::impl::MeshContext::receiveMeshFrom

Name of participant that creates the mesh.

Definition at line 29 of file MeshContext.hpp.

◆ safetyFactor

double precice::impl::MeshContext::safetyFactor = -1

bounding box to speed up decomposition of received mesh is increased by this safety factor

Definition at line 32 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 51 of file MeshContext.hpp.


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