Canoe
Comprehensive Atmosphere N' Ocean Engine
AbsorberFactory Class Reference

#include <absorber.hpp>

Static Public Member Functions

static AbsorberPtr CreateFrom (YAML::Node const &my, std::string band_name)
 Create an absorber from YAML node. More...
 
static AbsorberContainer CreateFrom (std::vector< std::string > const &names, std::string band_name, YAML::Node const &rad)
 Create absorbers from YAML node. More...
 

Public Attributes

std::string search_path
 

Static Protected Member Functions

static AbsorberPtr createAbsorberPartial (std::string name, std::string type)
 Only create an absorber based on its name and class. More...
 

Detailed Description

Definition at line 73 of file absorber.hpp.

Member Function Documentation

◆ CreateFrom() [1/2]

AbsorberPtr AbsorberFactory::CreateFrom ( YAML::Node const &  my,
std::string  band_name 
)
static

Create an absorber from YAML node.

Parameters
[in]myYAML node containing the current absorber
[in]band_namename of the radiation band

Definition at line 44 of file absorber_factory.cpp.

◆ CreateFrom() [2/2]

AbsorberContainer AbsorberFactory::CreateFrom ( std::vector< std::string > const &  names,
std::string  band_name,
YAML::Node const &  rad 
)
static

Create absorbers from YAML node.

Parameters
[in]namesnames of absorbers
[in]band_namename of the radiation band
[in]radYAML node containing the radiation input file

Definition at line 21 of file absorber_factory.cpp.

◆ createAbsorberPartial()

AbsorberPtr AbsorberFactory::createAbsorberPartial ( std::string  name,
std::string  type 
)
staticprotected

Only create an absorber based on its name and class.

Parameters
[in]namename of the absorber
[in]typeclass identifier of the absorber

Definition at line 84 of file absorber_factory.cpp.

Member Data Documentation

◆ search_path

std::string AbsorberFactory::search_path
Todo:
make it a static member of Absorber search path for radiation input file

Definition at line 77 of file absorber.hpp.


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