UMPIRE
Umpire: resource management and provision
umpire::resource::OpenMPTargetResourceFactory Class Reference

Factory class for constructing MemoryResource objects that use GPU memory. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/umpire/checkouts/develop/src/umpire/resource/OpenMPTargetMemoryResourceFactory.hpp>

Inheritance diagram for umpire::resource::OpenMPTargetResourceFactory:

Public Member Functions

bool isValidMemoryResourceFor (const std::string &name) noexcept final override
 
std::unique_ptr< resource::MemoryResourcecreate (const std::string &name, int id) final override
 Construct a MemoryResource with the given name and id. More...
 
std::unique_ptr< resource::MemoryResourcecreate (const std::string &name, int id, MemoryResourceTraits traits) final override
 Construct a MemoryResource with the given name and id. More...
 
MemoryResourceTraits getDefaultTraits () final override
 

Detailed Description

Factory class for constructing MemoryResource objects that use GPU memory.

Member Function Documentation

◆ isValidMemoryResourceFor()

bool umpire::resource::OpenMPTargetResourceFactory::isValidMemoryResourceFor ( const std::string &  name)
finaloverridevirtualnoexcept

◆ create() [1/2]

std::unique_ptr< resource::MemoryResource > umpire::resource::OpenMPTargetResourceFactory::create ( const std::string &  name,
int  id 
)
finaloverridevirtual

Construct a MemoryResource with the given name and id.

Parameters
nameName of the MemoryResource.
idID of the MemoryResource.
traitsTraits for the MemoryResource

Implements umpire::resource::MemoryResourceFactory.

References getDefaultTraits().

◆ create() [2/2]

std::unique_ptr< resource::MemoryResource > umpire::resource::OpenMPTargetResourceFactory::create ( const std::string &  name,
int  id,
MemoryResourceTraits  traits 
)
finaloverridevirtual

Construct a MemoryResource with the given name and id.

Parameters
nameName of the MemoryResource.
idID of the MemoryResource.
traitsTraits for the MemoryResource

Implements umpire::resource::MemoryResourceFactory.

References umpire::MemoryResourceTraits::id.

◆ getDefaultTraits()