PLaSK library
Loading...
Searching...
No Matches
plask::MaterialsDB::MixedCompositionAndDopantFactory Struct Reference

Factory of alloy material which construct its versions with mixed version of two compositions and dopants. More...

#include <plask/material/db.hpp>

Inheritance diagram for plask::MaterialsDB::MixedCompositionAndDopantFactory:
[legend]
Collaboration diagram for plask::MaterialsDB::MixedCompositionAndDopantFactory:
[legend]

Public Member Functions

 MixedCompositionAndDopantFactory (shared_ptr< const MaterialConstructor > constructor, const Material::Composition &material1composition, const Material::Composition &material2composition, double m1DopAmount, double m2DopAmount, double shape=1.)
 Construct MixedCompositionAndDopantFactory for given material constructor, two compositions and dopings amounts for this constructor.
 
shared_ptr< Materialoperator() (double m1_weight) const override
 Construct material.
 
shared_ptr< MaterialsingleMaterial () const override
 Get material only if this factory represents solid material (if operator(double m1_weight) is independent from m1_weight).
 
- Public Member Functions inherited from plask::MaterialsDB::MixedCompositionOnlyFactory
 MixedCompositionOnlyFactory (shared_ptr< const MaterialConstructor > constructor, const Material::Composition &material1composition, const Material::Composition &material2composition, double shape=1.)
 Construct MixedCompositionFactory for given material constructor and two compositions for this constructor.
 
shared_ptr< Materialoperator() (double m1_weight) const override
 Construct material.
 
shared_ptr< MaterialsingleMaterial () const override
 Get material only if this factory represents solid material (if operator(double m1_weight) is independent from m1_weight).
 
- Public Member Functions inherited from plask::MaterialsDB::MixedCompositionFactory
 MixedCompositionFactory (shared_ptr< const MaterialConstructor > constructor)
 Construct MixedCompositionFactory for given material constructor and two compositions for this constructor.
 
virtual ~MixedCompositionFactory ()
 

Protected Attributes

double m1DopAmount
 
double m2DopAmount
 
- Protected Attributes inherited from plask::MaterialsDB::MixedCompositionOnlyFactory
Material::Composition material1composition
 
Material::Composition material2composition
 
double shape
 
- Protected Attributes inherited from plask::MaterialsDB::MixedCompositionFactory
shared_ptr< const MaterialConstructorconstructor
 

Additional Inherited Members

- Protected Member Functions inherited from plask::MaterialsDB::MixedCompositionOnlyFactory
Material::Composition mixedComposition (double m1_weight) const
 Calculate mixed composition, of material1composition and material2composition.
 

Detailed Description

Factory of alloy material which construct its versions with mixed version of two compositions and dopants.

Definition at line 214 of file db.hpp.

Constructor & Destructor Documentation

◆ MixedCompositionAndDopantFactory()

plask::MaterialsDB::MixedCompositionAndDopantFactory::MixedCompositionAndDopantFactory ( shared_ptr< const MaterialConstructor constructor,
const Material::Composition material1composition,
const Material::Composition material2composition,
double  m1DopAmount,
double  m2DopAmount,
double  shape = 1. 
)
inline

Construct MixedCompositionAndDopantFactory for given material constructor, two compositions and dopings amounts for this constructor.

Parameters
constructormaterial constructor
material1compositionincomplate composition of first material
material2compositionincomplate composition of second material, must be defined for the same objects as material1composition
m1DopAmount,m2DopAmountamounts of doping for first and second material
shapechanging material shape exponent

Definition at line 227 of file db.hpp.

Member Function Documentation

◆ operator()()

shared_ptr< Material > plask::MaterialsDB::MixedCompositionAndDopantFactory::operator() ( double  m1_weight) const
inlineoverridevirtual

Construct material.

Parameters
m1_weightweight of first composition and dopant
Returns
constructed material

Implements plask::MaterialsDB::MixedCompositionFactory.

Definition at line 236 of file db.hpp.

◆ singleMaterial()

shared_ptr< Material > plask::MaterialsDB::MixedCompositionAndDopantFactory::singleMaterial ( ) const
inlineoverridevirtual

Get material only if this factory represents solid material (if operator(double m1_weight) is independent from m1_weight).

Returns
material or nullptr if it is not solid

Implements plask::MaterialsDB::MixedCompositionFactory.

Definition at line 241 of file db.hpp.

Member Data Documentation

◆ m1DopAmount

double plask::MaterialsDB::MixedCompositionAndDopantFactory::m1DopAmount
protected

Definition at line 216 of file db.hpp.

◆ m2DopAmount

double plask::MaterialsDB::MixedCompositionAndDopantFactory::m2DopAmount
protected

Definition at line 216 of file db.hpp.


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