AMP::Materials::Material Class Reference

#include <Material.h>

Inheritance diagram for AMP::Materials::Material:

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.
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
	Material ()=default
	Default constructor.
virtual std::string	materialName () const =0
	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.
virtual	~Material ()=default
	Default destructor.

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

Detailed Description

Material base class. Loose organizer to collect a group of properties.

Definition at line 20 of file Material.h.

Constructor & Destructor Documentation

Material()

AMP::Materials::Material::Material ( )

default

Default constructor.

~Material()

virtual AMP::Materials::Material::~Material ( )

virtualdefault

Default destructor.

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 = ""
	)

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 = ""
	)

Add a polynomial based property.

addProperty() [1/2]

template<class PROPERTY , typename... Args>

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

inline

Definition at line 63 of file Material.h.

References d_propertyMap, and materialName().

addProperty() [2/2]

template<class PROPERTY >

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

inline

Add a property.

Definition at line 58 of file Material.h.

References d_propertyMap, and 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 = ""
	)

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 = ""
	)

Add a constant-value fixed property.

addStringProperty()

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

Add a constant-value fixed property.

hasProperty()

bool AMP::Materials::Material::hasProperty

(

const std::string &

type

)

const

check if a property exists in the material

list()

std::vector< std::string > AMP::Materials::Material::list

(

)

const

return a list of all properties in this material

materialName()

virtual std::string AMP::Materials::Material::materialName ( ) const

pure virtual

Return the name of the material.

Implemented in AMP::Materials::DatabaseMaterial, AMP::Materials::CylindricallySymmetric, AMP::Materials::Dr_nonlinear, AMP::Materials::FixedClad, AMP::Materials::FixedFuel, AMP::Materials::Independent, AMP::Materials::Ox_MSRZC_09, AMP::Materials::Steel316_MSRZC_09, AMP::Materials::UO2_MSRZC_09, and AMP::Materials::WaterLibrary.

Referenced by addProperty().

property() [1/2]

std::shared_ptr< Property > AMP::Materials::Material::property

(

const std::string &

type

)

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 addProperty().

property() [2/2]

std::shared_ptr< const Property > AMP::Materials::Material::property

(

const std::string &

type

)

const

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

protected

database of scalar properties

Definition at line 107 of file Material.h.

Referenced by addProperty(), and addProperty().

---

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

• src/materials/Material.h