AMP::Materials::CylindricallySymmetric Class Reference

#include <MaterialList.h>

Inheritance diagram for AMP::Materials::CylindricallySymmetric:

Public Member Functions
void	addEquationProperty (std::string_view name, const AMP::Units &unit, std::string expression, std::vector< std::string > args={}, std::vector< std::array< double, 2 > > ranges={}, std::vector< AMP::Units > argUnits={}, std::string_view source="")
	Add an equation based propoerty.
void	addPolynomialProperty (std::string_view name, const AMP::Units &unit={}, std::vector< double > params={}, std::vector< std::string > args={}, std::vector< std::array< double, 2 > > ranges={}, std::vector< AMP::Units > argUnits={}, std::string_view source="")
	Add a polynomial based property.
template<class PROPERTY , typename... Args>
void	addProperty (std::string_view name, Args &&...args)
template<class PROPERTY >
void	addProperty (std::string_view name, std::shared_ptr< PROPERTY > property)
	Add a property.
void	addScalarProperty (std::string_view name, AMP::Array< double > value, const AMP::Units &unit=AMP::Units(), std::string_view source="")
	Add a constant-value fixed property.
void	addScalarProperty (std::string_view name, double value, const AMP::Units &unit=AMP::Units(), std::string_view source="")
	Add a constant-value fixed property.
void	addStringProperty (std::string_view name, std::string value, std::string_view source="")
	Add a constant-value fixed property.
	CylindricallySymmetric ()
bool	hasProperty (const std::string &type) const
	check if a property exists in the material
std::vector< std::string >	list () const
	return a list of all properties in this material
std::string	materialName () const override
	Return the name of the material.
std::shared_ptr< Property >	property (const std::string &type)
	Get the desired property.
std::shared_ptr< const Property >	property (const std::string &type) const
	Get the desired property.

Protected Attributes
std::map< std::string, std::shared_ptr< Property > >	d_propertyMap
	database of scalar properties

Detailed Description

Definition at line 11 of file MaterialList.h.

Constructor & Destructor Documentation

CylindricallySymmetric()

AMP::Materials::CylindricallySymmetric::CylindricallySymmetric

(

)

Member Function Documentation

addEquationProperty()

void AMP::Materials::Material::addEquationProperty ( std::string_view  name, const AMP::Units &  unit, std::string  expression, std::vector< std::string >  args = {}, std::vector< std::array< double, 2 > >  ranges = {}, std::vector< AMP::Units >  argUnits = {}, std::string_view  source = ""  )

inherited

Add an equation based propoerty.

addPolynomialProperty()

void AMP::Materials::Material::addPolynomialProperty ( std::string_view  name, const AMP::Units &  unit = {}, std::vector< double >  params = {}, std::vector< std::string >  args = {}, std::vector< std::array< double, 2 > >  ranges = {}, std::vector< AMP::Units >  argUnits = {}, std::string_view  source = ""  )

inherited

Add a polynomial based property.

addProperty() [1/2]

template<class PROPERTY , typename... Args>

void AMP::Materials::Material::addProperty ( std::string_view  name, Args &&...  args  )

inlineinherited

Definition at line 63 of file Material.h.

References AMP::Materials::Material::d_propertyMap, and AMP::Materials::Material::materialName().

addProperty() [2/2]

template<class PROPERTY >

void AMP::Materials::Material::addProperty ( std::string_view  name, std::shared_ptr< PROPERTY >  property  )

inlineinherited

Add a property.

Definition at line 58 of file Material.h.

References AMP::Materials::Material::d_propertyMap, and AMP::Materials::Material::property().

addScalarProperty() [1/2]

void AMP::Materials::Material::addScalarProperty ( std::string_view  name, AMP::Array< double >  value, const AMP::Units &  unit = AMP::Units(), std::string_view  source = ""  )

inherited

Add a constant-value fixed property.

addScalarProperty() [2/2]

void AMP::Materials::Material::addScalarProperty ( std::string_view  name, double  value, const AMP::Units &  unit = AMP::Units(), std::string_view  source = ""  )

inherited

Add a constant-value fixed property.

addStringProperty()

void AMP::Materials::Material::addStringProperty ( std::string_view  name, std::string  value, std::string_view  source = ""  )

inherited

Add a constant-value fixed property.

hasProperty()

bool AMP::Materials::Material::hasProperty ( const std::string &  type ) const

inherited

check if a property exists in the material

list()

std::vector< std::string > AMP::Materials::Material::list ( ) const

inherited

return a list of all properties in this material

materialName()

std::string AMP::Materials::CylindricallySymmetric::materialName ( ) const

inlineoverridevirtual

Return the name of the material.

Implements AMP::Materials::Material.

Definition at line 15 of file MaterialList.h.

property() [1/2]

std::shared_ptr< Property > AMP::Materials::Material::property ( const std::string &  type )

inherited

Get the desired property.

Return a shared_ptr to the desired property if it exists. If it does not exist, return a nullptr.

Parameters

type	Name of desired property

Referenced by AMP::Materials::Material::addProperty().

property() [2/2]

std::shared_ptr< const Property > AMP::Materials::Material::property ( const std::string &  type ) const

inherited

Get the desired property.

Return a shared_ptr to the desired property if it exists. If it does not exist, return a nullptr.

Parameters

type	Name of desired property

Member Data Documentation

d_propertyMap

std::map<std::string, std::shared_ptr<Property> > AMP::Materials::Material::d_propertyMap

protectedinherited

database of scalar properties

Definition at line 107 of file Material.h.

Referenced by AMP::Materials::Material::addProperty(), and AMP::Materials::Material::addProperty().

---

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

• src/materials/MaterialList.h