Public Member Functions | Static Public Member Functions | List of all members
openfluid::machine::Factory Class Reference

#include <machine/Factory.hpp>

Public Member Functions

 Factory ()=delete
 

Static Public Member Functions

static void buildDomainFromDescriptor (const openfluid::fluidx::SpatialDomainDescriptor &Descriptor, openfluid::core::SpatialGraph &SGraph)
 
static void buildDatastoreFromDescriptor (const openfluid::fluidx::DatastoreDescriptor &Descriptor, openfluid::core::Datastore &Store)
 
static void buildModelInstanceFromDescriptor (const openfluid::fluidx::CoupledModelDescriptor &ModelDesc, ModelInstance &MInstance)
 
static void buildMonitoringInstanceFromDescriptor (const openfluid::fluidx::MonitoringDescriptor &MonDesc, MonitoringInstance &MonInstance)
 
static void fillRunContextFromDescriptor (const openfluid::fluidx::RunConfigurationDescriptor &RunDesc)
 
static void buildSimulationBlobFromDescriptors (const openfluid::fluidx::FluidXDescriptor &FluidXDesc, SimulationBlob &SimBlob)
 
static std::string buildGeneratorID (const openfluid::core::VariableName_t &VarName, bool IsVector, const openfluid::core::UnitsClass_t &ClassName)
 

Constructor & Destructor Documentation

◆ Factory()

openfluid::machine::Factory::Factory ( )
delete

Member Function Documentation

◆ buildDatastoreFromDescriptor()

static void openfluid::machine::Factory::buildDatastoreFromDescriptor ( const openfluid::fluidx::DatastoreDescriptor Descriptor,
openfluid::core::Datastore Store 
)
static

Builds a datastore from a datastore descriptor

Parameters
[in]Descriptorthe datastore descriptor
[out]Storethe instanciated datastore

◆ buildDomainFromDescriptor()

static void openfluid::machine::Factory::buildDomainFromDescriptor ( const openfluid::fluidx::SpatialDomainDescriptor Descriptor,
openfluid::core::SpatialGraph SGraph 
)
static

Builds a spatial graph from a domain descriptor

Parameters
[in]Descriptorthe spatial domain descriptor
[out]SGraphthe instanciated spatial graph

◆ buildGeneratorID()

static std::string openfluid::machine::Factory::buildGeneratorID ( const openfluid::core::VariableName_t VarName,
bool  IsVector,
const openfluid::core::UnitsClass_t ClassName 
)
inlinestatic

Builds a generator ID

Parameters
[in]VarNameThe name of the variable produced by the generator
[in]IsVectortrue if the variable is a vector, false if it is a scalar
[in]ClassNameThe name of the spatial unit class associated where the variable is produced
Returns
the generated ID

◆ buildModelInstanceFromDescriptor()

static void openfluid::machine::Factory::buildModelInstanceFromDescriptor ( const openfluid::fluidx::CoupledModelDescriptor ModelDesc,
ModelInstance MInstance 
)
static

Builds a coupled model instance from a model descriptor

Parameters
[in]ModelDescthe model descriptor
[out]MInstancethe instanciated coupled model

◆ buildMonitoringInstanceFromDescriptor()

static void openfluid::machine::Factory::buildMonitoringInstanceFromDescriptor ( const openfluid::fluidx::MonitoringDescriptor MonDesc,
MonitoringInstance MonInstance 
)
static

Builds a monitoring instance from a monitoring descriptor

Parameters
[in]MonDescthe monitoring descriptor
[out]MonInstancethe instanciated monitoring

◆ buildSimulationBlobFromDescriptors()

static void openfluid::machine::Factory::buildSimulationBlobFromDescriptors ( const openfluid::fluidx::FluidXDescriptor FluidXDesc,
SimulationBlob SimBlob 
)
static

Builds a simulation blob from descriptors

Parameters
[in]FluidXDescthe descriptors
[out]SimBlobthe instanciated simulation blob

◆ fillRunContextFromDescriptor()

static void openfluid::machine::Factory::fillRunContextFromDescriptor ( const openfluid::fluidx::RunConfigurationDescriptor RunDesc)
static

Fills the current run context from a run configuration descriptor

Parameters
[in]RunDescthe run configuration descriptor

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