Version: 9.12.0
MEDCoupling::DECOptions Class Reference
Inheritance diagram for MEDCoupling::DECOptions:

Public Member Functions

 DECOptions ()
 
 DECOptions (const DECOptions &deco)
 
AllToAllMethod getAllToAllMethod () const
 
bool getAsynchronous () const
 
bool getForcedRenormalization () const
 
const std::string & getMethod () const
 
TimeInterpolationMethod getTimeInterpolationMethod () const
 
void setAllToAllMethod (AllToAllMethod sp)
 
void setAsynchronous (bool dr)
 
void setForcedRenormalization (bool dr)
 
void setMethod (const char *m)
 
void setTimeInterpolationMethod (TimeInterpolationMethod it)
 

Protected Attributes

AllToAllMethod _allToAllMethod
 
bool _asynchronous
 
bool _forcedRenormalization
 
std::string _method
 
TimeInterpolationMethod _timeInterpolationMethod
 

Detailed Description

This class groups the various options accepted by all DECs (which all inherit from DECOptions).

The following code excerpt shows how to set options on a DEC :

InterpKernelDEC dec(source_group,target_group);
dec.setForcedRenormalization(true);
dec.attachLocalField(field);
dec.synchronize();
if (source_group.containsMyRank())
dec.sendData();
else
dec.recvData();

Constructor & Destructor Documentation

◆ DECOptions() [1/2]

MEDCoupling::DECOptions::DECOptions ( )

◆ DECOptions() [2/2]

MEDCoupling::DECOptions::DECOptions ( const DECOptions deco)

Member Function Documentation

◆ getMethod()

const std::string& MEDCoupling::DECOptions::getMethod ( ) const

◆ setMethod()

void MEDCoupling::DECOptions::setMethod ( const char *  m)

Set interpolation method. Defaults to "P0".

References _method.

◆ getTimeInterpolationMethod()

TimeInterpolationMethod MEDCoupling::DECOptions::getTimeInterpolationMethod ( ) const

◆ setTimeInterpolationMethod()

void MEDCoupling::DECOptions::setTimeInterpolationMethod ( TimeInterpolationMethod  it)

Set time interpolation method. Default to WithoutTimeInterp.

References _timeInterpolationMethod.

◆ getForcedRenormalization()

bool MEDCoupling::DECOptions::getForcedRenormalization ( ) const

◆ setForcedRenormalization()

void MEDCoupling::DECOptions::setForcedRenormalization ( bool  dr)

Force renormalization of the field after it has been received so that the total sum of the field values are the same on both the sending and the receiving side. Defaults to false.

References _forcedRenormalization.

◆ getAsynchronous()

bool MEDCoupling::DECOptions::getAsynchronous ( ) const
See also
setAsynchronous()

References _asynchronous.

◆ setAsynchronous()

void MEDCoupling::DECOptions::setAsynchronous ( bool  dr)

Switch to asynchronous data transfer mode. Default is false.

References _asynchronous.

◆ getAllToAllMethod()

AllToAllMethod MEDCoupling::DECOptions::getAllToAllMethod ( ) const
See also
setAllToAllMethod()

References _allToAllMethod.

◆ setAllToAllMethod()

void MEDCoupling::DECOptions::setAllToAllMethod ( AllToAllMethod  sp)

Set the broadcast method for synchronisation processes. Default to Native.

References _allToAllMethod.

Member Data Documentation

◆ _method

std::string MEDCoupling::DECOptions::_method
protected

◆ _asynchronous

bool MEDCoupling::DECOptions::_asynchronous
protected

◆ _timeInterpolationMethod

TimeInterpolationMethod MEDCoupling::DECOptions::_timeInterpolationMethod
protected

◆ _allToAllMethod

AllToAllMethod MEDCoupling::DECOptions::_allToAllMethod
protected

◆ _forcedRenormalization

bool MEDCoupling::DECOptions::_forcedRenormalization
protected