BioDynaMo  v1.03.58-27764645
Public Member Functions | Public Attributes | List of all members
bdm::OperationImpl Struct Referenceabstract

#include <operation.h>

Inheritance diagram for bdm::OperationImpl:
[legend]

Public Member Functions

virtual ~OperationImpl ()=default
 
virtual void SetUp ()
 
virtual void TearDown ()
 
virtual void operator() (Agent *agent)=0
 
virtual void operator() ()=0
 
virtual OperationImplClone ()=0
 
bool IsGpuOperation ()
 Returns whether or not this operation is supposed to run on a GPU. More...
 
virtual bool IsStandalone ()=0
 Returns whether or not this operations is a stand-alone operation. More...
 

Public Attributes

OpComputeTarget target_ = kCpu
 The target that this operation implementation is supposed to run on. More...
 

Detailed Description

Definition at line 45 of file operation.h.

Constructor & Destructor Documentation

◆ ~OperationImpl()

virtual bdm::OperationImpl::~OperationImpl ( )
virtualdefault

Member Function Documentation

◆ Clone()

virtual OperationImpl* bdm::OperationImpl::Clone ( )
pure virtual

Operation implementations can be cloned. This function should return a copy of the operation implementation

◆ IsGpuOperation()

bool bdm::OperationImpl::IsGpuOperation ( )
inline

Returns whether or not this operation is supposed to run on a GPU.

Definition at line 65 of file operation.h.

◆ IsStandalone()

virtual bool bdm::OperationImpl::IsStandalone ( )
pure virtual

Returns whether or not this operations is a stand-alone operation.

Implemented in bdm::StandaloneOperationImpl, and bdm::AgentOperationImpl.

◆ operator()() [1/2]

virtual void bdm::OperationImpl::operator() ( )
pure virtual

◆ operator()() [2/2]

virtual void bdm::OperationImpl::operator() ( Agent agent)
pure virtual

◆ SetUp()

virtual void bdm::OperationImpl::SetUp ( )
inlinevirtual

This function is run before the operator() call. It is useful to perform tasks such as data transfer from CPU -> GPU in GPU operations

Reimplemented in bdm::ReductionOp< T >, and bdm::MechanicalForcesOpCuda.

Definition at line 50 of file operation.h.

◆ TearDown()

virtual void bdm::OperationImpl::TearDown ( )
inlinevirtual

This function is run after the operator() call. It is useful to perform tasks such as data transfer from GPU -> CPU in GPU operations

Reimplemented in bdm::ReductionOp< T >, and bdm::MechanicalForcesOpCuda.

Definition at line 54 of file operation.h.

Member Data Documentation

◆ target_

OpComputeTarget bdm::OperationImpl::target_ = kCpu

The target that this operation implementation is supposed to run on.

Definition at line 71 of file operation.h.


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