v0.16.3
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
MoFEM::CouplerInterface Struct Referenceabstract

#include "src/interfaces/CouplerInterface.hpp"

Inheritance diagram for MoFEM::CouplerInterface:
[legend]
Collaboration diagram for MoFEM::CouplerInterface:
[legend]

Classes

struct  Locations
 Target-to-source matches tied to one generation of the backend point cache. More...
 
struct  Options
 
struct  Report
 
struct  Selection
 
struct  TagMap
 
struct  Transfer
 Source selection, search backend and routing state shared by location batches. More...
 

Public Types

enum class  Sampling { ELEMENT_CONSTANT , VERTEX_LINEAR , ELEMENT_RECOVERED_LINEAR , VERTEX_AVERAGED_CONSTANT }
 
enum class  Missing { ERROR , KEEP , ADJACENT_ELEMENT_AVERAGE }
 
enum class  Target { VERTICES , ELEMENT_CENTROIDS }
 
enum class  SourceLayout { REPLICATED , DISTRIBUTED }
 
using TransferPtr = boost::shared_ptr< Transfer >
 
using LocationsPtr = boost::shared_ptr< const Locations >
 

Public Member Functions

 ~CouplerInterface () override=default
 
virtual MoFEMErrorCode createTransfer (const Selection &source, const Options &options, TransferPtr &transfer)=0
 Build a source-only search. Source elements require unique positive GLOBAL_IDs.
 
virtual MoFEMErrorCode locateTargets (const TransferPtr &transfer, const Selection &target, LocationsPtr &locations, Report &report)=0
 
virtual MoFEMErrorCode transferTags (const TransferPtr &transfer, const LocationsPtr &locations, const std::vector< TagMap > &tags, Report &report)=0
 
virtual MoFEMErrorCode destroyTransfer (TransferPtr &transfer)=0
 Idempotent explicit close; invalidate aliases. Destructors never call MPI.
 
- Public Member Functions inherited from MoFEM::UnknownInterface
virtual MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const =0
 
template<class IFACE >
MoFEMErrorCode registerInterface (bool error_if_registration_failed=true)
 Register interface.
 
template<class IFACE >
MoFEMErrorCode getInterface (IFACE *&iface) const
 Get interface reference to pointer of interface.
 
template<class IFACE >
MoFEMErrorCode getInterface (IFACE **const iface) const
 Get interface pointer to pointer of interface.
 
template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE getInterface () const
 Get interface pointer to pointer of interface.
 
template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE getInterface () const
 Get reference to interface.
 
template<class IFACE >
IFACE * getInterface () const
 Function returning pointer to interface.
 
virtual ~UnknownInterface ()=default
 

Additional Inherited Members

- Static Public Member Functions inherited from MoFEM::UnknownInterface
static MoFEMErrorCode getLibVersion (Version &version)
 Get library version.
 
static MoFEMErrorCode getFileVersion (moab::Interface &moab, Version &version)
 Get database major version.
 
static MoFEMErrorCode setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
 Get database major version.
 
static MoFEMErrorCode getInterfaceVersion (Version &version)
 Get database major version.
 

Detailed Description

All operations are collective on the Core communicator, in the same order. Selections contain linear tets/hexes; geometry must remain fixed until close. This is interpolation/recovery, not conservative or constitutive transport. The interface is available without MBCoupler, but transfers then fail explicitly.

Definition at line 16 of file CouplerInterface.hpp.

Member Typedef Documentation

◆ LocationsPtr

using MoFEM::CouplerInterface::LocationsPtr = boost::shared_ptr<const Locations>

Definition at line 56 of file CouplerInterface.hpp.

◆ TransferPtr

using MoFEM::CouplerInterface::TransferPtr = boost::shared_ptr<Transfer>

Definition at line 55 of file CouplerInterface.hpp.

Member Enumeration Documentation

◆ Missing

Enumerator
ERROR 
KEEP 
ADJACENT_ELEMENT_AVERAGE 

Definition at line 24 of file CouplerInterface.hpp.

◆ Sampling

Enumerator
ELEMENT_CONSTANT 
VERTEX_LINEAR 
ELEMENT_RECOVERED_LINEAR 
VERTEX_AVERAGED_CONSTANT 

Definition at line 18 of file CouplerInterface.hpp.

◆ SourceLayout

Enumerator
REPLICATED 
DISTRIBUTED 

Definition at line 26 of file CouplerInterface.hpp.

◆ Target

Enumerator
VERTICES 
ELEMENT_CENTROIDS 

Definition at line 25 of file CouplerInterface.hpp.

Constructor & Destructor Documentation

◆ ~CouplerInterface()

MoFEM::CouplerInterface::~CouplerInterface ( )
overridedefault

Member Function Documentation

◆ createTransfer()

virtual MoFEMErrorCode MoFEM::CouplerInterface::createTransfer ( const Selection &  source,
const Options &  options,
TransferPtr &  transfer 
)
pure virtual

Build a source-only search. Source elements require unique positive GLOBAL_IDs.

◆ destroyTransfer()

virtual MoFEMErrorCode MoFEM::CouplerInterface::destroyTransfer ( TransferPtr &  transfer)
pure virtual

Idempotent explicit close; invalidate aliases. Destructors never call MPI.

◆ locateTargets()

virtual MoFEMErrorCode MoFEM::CouplerInterface::locateTargets ( const TransferPtr &  transfer,
const Selection &  target,
LocationsPtr &  locations,
Report &  report 
)
pure virtual

Cache locations independently of tags; starting a new backend batch invalidates older locations even if the replacement search fails. Missing points are reported here; transferTags applies the missing policy.

◆ transferTags()

virtual MoFEMErrorCode MoFEM::CouplerInterface::transferTags ( const TransferPtr &  transfer,
const LocationsPtr &  locations,
const std::vector< TagMap > &  tags,
Report &  report 
)
pure virtual

Stage all maps before writing any target. New tags are sparse without a default; existing definitions/defaults are preserved. KEEP requires finite existing data on each miss (explicit sparse data or a declared default). Recoverable publication failures restore previous target values.


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