NetDEM v1.0
Loading...
Searching...
No Matches
netdem::BondEntryParser Class Reference

A class that provides functions to convert bond entry data between a class and a struct format. More...

#include <bond_entry_parser.hpp>

Static Public Member Functions

static void ClassToStruct (const BondEntry *const entry_class, BondEntryData *const entry_struct)
 Converts bond entry data from a class to a struct format.
 
static void StructToClass (BondEntry *const entry_class, const BondEntryData *const entry_struct, const MiniMap< int, ContactModel * > &contact_model_map)
 Converts bond entry data from a struct to a class format.
 
static void DefineMPIDataType (MPI_Datatype *const datatype)
 Defines an MPI datatype for a BondEntryData struct.
 

Detailed Description

A class that provides functions to convert bond entry data between a class and a struct format.

The BondEntryParser class is used to provide functionality for converting bond entry data between a class and a struct format.

Member Function Documentation

◆ ClassToStruct()

void BondEntryParser::ClassToStruct ( const BondEntry *const entry_class,
BondEntryData *const entry_struct )
static

Converts bond entry data from a class to a struct format.

This function converts bond entry data from a BondEntry class format to a BondEntryData struct format.

Parameters
entry_classA pointer to the input BondEntry class instance.
entry_structA pointer to the output BondEntryData struct instance.

◆ DefineMPIDataType()

void BondEntryParser::DefineMPIDataType ( MPI_Datatype *const datatype)
static

Defines an MPI datatype for a BondEntryData struct.

This function defines an MPI datatype for a BondEntryData struct to be used in MPI communications.

Parameters
datatypeA pointer to the output datatype.

◆ StructToClass()

void BondEntryParser::StructToClass ( BondEntry *const entry_class,
const BondEntryData *const entry_struct,
const MiniMap< int, ContactModel * > & contact_model_map )
static

Converts bond entry data from a struct to a class format.

This function converts bond entry data from a BondEntryData struct format to a BondEntry class format.

Parameters
entry_classA pointer to the output BondEntry class instance.
entry_structA pointer to the input BondEntryData struct instance.
contact_model_mapA map of ID-contact model pairs used for setting the correct contact model in the output BondEntry class instance.

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