ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | List of all members
NeutralTerritory Class Reference

#include <NeutralTerritory.h>

Inheritance diagram for NeutralTerritory:
ZonalMethod

Public Member Functions

std::vector< HaloRegiongetHaloImportForceExportRegions (HaloRegion &initialRegion, double cutoffRadius, bool coversWholeDomain[3], double cellLength[3]) override
 
std::vector< HaloRegiongetHaloExportForceImportRegions (HaloRegion &initialRegion, double cutoffRadius, bool coversWholeDomain[3], double cellLength[3]) override
 
- Public Member Functions inherited from ZonalMethod
virtual std::vector< HaloRegiongetLeavingExportRegions (HaloRegion &initialRegion, double cutoffRadius, bool coversWholeDomain[3])
 
virtual std::vector< HaloRegiongetLeavingExportRegions (HaloRegion &initialRegion, double cutoffRadius[3], bool coversWholeDomain[3])
 

Additional Inherited Members

- Protected Member Functions inherited from ZonalMethod
std::vector< HaloRegiongetHaloRegionsConditional (HaloRegion &initialRegion, double cutoffRadius, bool coversWholeDomain[3], const std::function< bool(const int[3])> &condition)
 
std::vector< HaloRegiongetHaloRegionsConditional (HaloRegion &initialRegion, const double cutoffRadius[3], bool coversWholeDomain[3], const std::function< bool(const int[3])> &condition)
 
std::vector< HaloRegiongetHaloRegionsConditionalInside (HaloRegion &initialRegion, double cutoffRadius, bool coversWholeDomain[3], const std::function< bool(const int[3])> &condition)
 
std::vector< HaloRegiongetHaloRegionsConditionalInside (HaloRegion &initialRegion, const double cutoffRadius[3], bool coversWholeDomain[3], const std::function< bool(const int[3])> &condition)
 

Detailed Description

This class implements the NeutralTerritory method according to Shaw et. al. (A Fast, Scalable Method ..., 2005)

Member Function Documentation

◆ getHaloExportForceImportRegions()

std::vector<HaloRegion> NeutralTerritory::getHaloExportForceImportRegions ( HaloRegion initialRegion,
double  cutoffRadius,
bool  coversWholeDomain[3],
double  cellLength[3] 
)
inlineoverridevirtual

Returns the export halo Regions of the process. These regions are also the ForceImport Regions of a process, if it is a force-importer. This indicates, where the processes lie that require halo copies from the current process.

Parameters
initialRegionboundary of the current process
cutoffRadius
coversWholeDomain
cellLength
Returns
vector of regions

Implements ZonalMethod.

◆ getHaloImportForceExportRegions()

std::vector<HaloRegion> NeutralTerritory::getHaloImportForceExportRegions ( HaloRegion initialRegion,
double  cutoffRadius,
bool  coversWholeDomain[3],
double  cellLength[3] 
)
inlineoverridevirtual

Returns the import halo Regions of the process. These regions are also the ForceExport Regions of a process, if it is a force-exporter. This indicates, where the processes lie that require halo copies from the current process.

Parameters
initialRegionboundary of the current process
cutoffRadius
coversWholeDomain
cellLength
Returns
vector of regions

Implements ZonalMethod.


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