Scalar property class (fixed value) More...

#include <ScalarProperty.h>

Inheritance diagram for AMP::Materials::ScalarProperty:

Public Member Functions
void	eval (AMP::Array< double > &result, const AMP::Array< double > &) const override

double	eval (const Units &unit, const std::vector< std::string > &args, const std::vector< double > &vec, const std::vector< Units > &units={}) const
	Evaluate the property.

template<class... Args>
double	eval (const Units &unit=Units(), const Args &...args) const
	Evaluate the property.

virtual std::string	evalString () const
	Get the string value of the property.

template<class... Args>
void	evalv (AMP::Array< AMP::LinearAlgebra::Vector * > &r, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (AMP::Array< std::shared_ptr< AMP::LinearAlgebra::Vector > > &r, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (AMP::Array< std::shared_ptr< std::vector< double > > > &r, const Units &unit, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (AMP::Array< std::vector< double > * > &r, const Units &unit, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (AMP::LinearAlgebra::Vector &r, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (std::vector< double > &r, const Units &unit, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (std::vector< std::shared_ptr< AMP::LinearAlgebra::Vector > > &r, const Args &...args) const
	Evaluate the property.

template<class... Args>
void	evalv (std::vector< std::shared_ptr< std::vector< double > > > &r, const Units &unit, const Args &...args) const
	Evaluate the property.

std::array< double, 2 >	get_arg_range (std::string_view argname) const
	Get range for a specific argument.

const auto &	get_arg_ranges () const
	Get ranges for all arguments used in this material.

const auto &	get_arg_units () const
	Get units for all arguments used in this material.

int	get_argument_index (std::string_view name) const
	Return the argument index.

const std::vector< std::string > &	get_arguments () const
	Return the names of the arguments to eval.

double	get_default (std::string_view name) const
	Get the default for the given argument (NaN if it is an invalid argument)

const std::vector< double > &	get_defaults () const
	Get the defaults.

const std::string &	get_name () const
	Return name of property.

size_t	get_number_arguments () const
	Return the number of arguments to eval.

const std::string &	get_source () const
	Get the source of the information.

const Units &	get_units () const
	Return source reference.

const Database &	getAuxiliaryData () const
	Get auxiliary data.

template<class TYPE >
TYPE	getAuxiliaryData (const std::string &key) const
	Get auxiliary data.

const AMP::Array< double > &	getValue () const

template<class INPUT_VTYPE >
bool	in_range (std::string_view argname, const INPUT_VTYPE &values, const Units &unit=Units(), bool throwError=false) const
	Determine if a set of values are all within range or not.

bool	in_range (std::string_view argname, double value, const Units &unit=Units(), bool throwError=false) const
	Determine if a value is within range or not.

bool	is_argument (std::string_view argname) const
	Determine if a string is an argument.

bool	isScalar () const
	Indicator for scalar evaluator.

virtual bool	isString () const
	Indicator for scalar evaluator.

bool	isTensor () const
	Indicator for tensor evaluator.

bool	isVector () const
	Indicator for vector evaluator.

std::map< std::string, std::shared_ptr< AMP::LinearAlgebra::Vector > >	make_map (const std::shared_ptr< AMP::LinearAlgebra::MultiVector > &args, const std::map< std::string, std::string > &translator) const

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

	ScalarProperty (std::string_view name, double value, const AMP::Units &unit=AMP::Units(), std::string_view source="")

void	set_default (std::string_view name, double value, const AMP::Units &unit=AMP::Units())
	Set the default.

void	set_defaults (std::vector< double > defaults)
	Set the defaults.

template<class TYPE >
void	setAuxiliaryData (const std::string &key, const TYPE &data)
	Set auxiliary data.

const ArraySize &	size () const
	get dimensions of evalv return value

Protected Member Functions
void	checkArgs (const AMP::Array< double > &args) const
	Check the argument values.

AMP::Array< double >	defaultArgs (size_t) const
	Create the default argument array.

void	evalArg (AMP::Array< double > &, std::string_view, const Units &, const AMP::LinearAlgebra::Vector &) const

void	evalArg (AMP::Array< double > &, std::string_view, const Units &, const std::vector< double > &) const

void	evalArg (AMP::Array< double > &, std::string_view, const Units &, double) const

void	evalArgs (AMP::Array< double > &) const

template<class VEC >
void	evalArgs (AMP::Array< double > &, const std::map< std::string, VEC > &) const

void	evalArgs (AMP::Array< double > &, const std::shared_ptr< AMP::LinearAlgebra::MultiVector > &, const std::map< std::string, std::string > &={}) const

void	evalArgs (AMP::Array< double > &, const std::vector< double > &args, const std::vector< std::string > &names, const std::vector< Units > &argUnits={}) const

template<class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const AMP::LinearAlgebra::Vector &, const Args &...) const

template<class VEC , class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const std::shared_ptr< VEC > &, const Args &...) const

template<class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const std::vector< double > &, const Args &...) const

template<class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const Units &, const AMP::LinearAlgebra::Vector &, const Args &...) const

template<class VEC , class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const Units &, const std::shared_ptr< VEC > &, const Args &...) const

template<class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const Units &, const std::vector< double > &, const Args &...) const

template<class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, const Units &, double, const Args &...) const

template<class... Args>
void	evalArgs (AMP::Array< double > &, std::string_view, double, const Args &...) const

void	evalv (const AMP::Array< double > &, AMP::Array< AMP::LinearAlgebra::Vector * > &) const

void	evalv (const AMP::Array< double > &, AMP::Array< std::vector< double > * > &, const Units &) const

int	get_arg_index (std::string_view name) const

Static Protected Member Functions
static size_t	getSize (const AMP::LinearAlgebra::Vector &)

static Units	getUnits (const AMP::LinearAlgebra::Vector &)

Protected Attributes
std::map< std::string_view, size_t >	d_argToIndexMap
	map argument names to indices

std::vector< std::string >	d_arguments
	names of the arguments

std::vector< Units >	d_argUnits
	default units for the arguments

AMP::Database	d_auxiliaryData
	Database containing auxiliary data.

std::vector< double >	d_defaults
	default values of arguments

AMP::ArraySize	d_dim
	size of the result

std::string	d_name
	should be unique

std::vector< std::array< double, 2 > >	d_ranges
	allowed ranges of arguments

std::string	d_source
	reference for source data

AMP::Units	d_units
	default units to return

Private Attributes
AMP::Array< double >	d_value

Detailed Description

Scalar property class (fixed value)

Definition at line 37 of file ScalarProperty.h.

Constructor & Destructor Documentation

◆ ScalarProperty() [1/2]

AMP::Materials::ScalarProperty::ScalarProperty	(	std::string_view	name,
		double	value,
		const AMP::Units &	unit = `AMP::Units()`,
		std::string_view	source = `""`
	)

◆ ScalarProperty() [2/2]

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

Member Function Documentation

◆ checkArgs()

void AMP::Materials::Property::checkArgs ( const AMP::Array< double > & args ) const

protectedinherited

Check the argument values.

◆ defaultArgs()

AMP::Array< double > AMP::Materials::Property::defaultArgs ( size_t ) const

protectedinherited

Create the default argument array.

◆ eval() [1/3]

void AMP::Materials::ScalarProperty::eval	(	AMP::Array< double > &	result,
		const AMP::Array< double > &	args
	)		const

overridevirtual

scalar evaluation function for a single argument set

Parameters

result	Output result (N)
args	Input arguments (MxN)

Implements AMP::Materials::Property.

◆ eval() [2/3]

double AMP::Materials::Property::eval	(	const Units &	unit,
		const std::vector< std::string > &	args,
		const std::vector< double > &	vec,
		const std::vector< Units > &	units = `{}`
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions

Parameters

unit	The desired units of the result. If this is not specified, the native units of the property are use (see get_units())
args	List of arguments for the property
units	List of units for each argument
vec	List of values for each argument

Returns: scalar value of property

◆ eval() [3/3]

template<class... Args>

double AMP::Materials::Property::eval	(	const Units &	unit = `Units()`,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions

Parameters

unit	The desired units of the result. If this is not specified, the native units of the property are use (see get_units())
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

Returns: scalar value of property

◆ evalArg() [1/3]

void AMP::Materials::Property::evalArg	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		const AMP::LinearAlgebra::Vector &
	)		const

protectedinherited

◆ evalArg() [2/3]

void AMP::Materials::Property::evalArg	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		const std::vector< double > &
	)		const

protectedinherited

◆ evalArg() [3/3]

void AMP::Materials::Property::evalArg	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		double
	)		const

protectedinherited

◆ evalArgs() [1/12]

void AMP::Materials::Property::evalArgs ( AMP::Array< double > & ) const

inlineprotectedinherited

Definition at line 336 of file Property.h.

◆ evalArgs() [2/12]

template<class VEC >

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		const std::map< std::string, VEC > &
	)		const

protectedinherited

◆ evalArgs() [3/12]

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		const std::shared_ptr< AMP::LinearAlgebra::MultiVector > &	,
		const std::map< std::string, std::string > &	= `{}`
	)		const

protectedinherited

◆ evalArgs() [4/12]

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		const std::vector< double > &	args,
		const std::vector< std::string > &	names,
		const std::vector< Units > &	argUnits = `{}`
	)		const

protectedinherited

◆ evalArgs() [5/12]

template<class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const AMP::LinearAlgebra::Vector &	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [6/12]

template<class VEC , class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const std::shared_ptr< VEC > &	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [7/12]

template<class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const std::vector< double > &	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [8/12]

template<class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		const AMP::LinearAlgebra::Vector &	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [9/12]

template<class VEC , class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		const std::shared_ptr< VEC > &	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [10/12]

template<class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		const std::vector< double > &	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [11/12]

template<class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		const Units &	,
		double	,
		const Args &	...
	)		const

protectedinherited

◆ evalArgs() [12/12]

template<class... Args>

void AMP::Materials::Property::evalArgs	(	AMP::Array< double > &	,
		std::string_view	,
		double	,
		const Args &	...
	)		const

protectedinherited

◆ evalString()

virtual std::string AMP::Materials::Property::evalString ( ) const

virtualinherited

Get the string value of the property.

Reimplemented in AMP::Materials::StringProperty.

◆ evalv() [1/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	AMP::Array< AMP::LinearAlgebra::Vector * > &	r,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	std::vector of return values
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ evalv() [2/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	AMP::Array< std::shared_ptr< AMP::LinearAlgebra::Vector > > &	r,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	Vector of return values
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ evalv() [3/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	AMP::Array< std::shared_ptr< std::vector< double > > > &	r,
		const Units &	unit,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	std::vector of return values
unit	Units to use for return values
args	Optional arguments specifying input arguments to the eval() function

◆ evalv() [4/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	AMP::Array< std::vector< double > * > &	r,
		const Units &	unit,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	std::vector of return values
unit	The desired units of the result. If this is not specified, the native units of the property are use (see get_units())
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ evalv() [5/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	AMP::LinearAlgebra::Vector &	r,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	std::vector of return values
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ evalv() [6/10]

void AMP::Materials::Property::evalv	(	const AMP::Array< double > &	,
		AMP::Array< AMP::LinearAlgebra::Vector * > &
	)		const

protectedinherited

◆ evalv() [7/10]

void AMP::Materials::Property::evalv	(	const AMP::Array< double > &	,
		AMP::Array< std::vector< double > * > &	,
		const Units &
	)		const

protectedinherited

◆ evalv() [8/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	std::vector< double > &	r,
		const Units &	unit,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	std::vector of return values
unit	The desired units of the result. If this is not specified, the native units of the property are use (see get_units())
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ evalv() [9/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	std::vector< std::shared_ptr< AMP::LinearAlgebra::Vector > > &	r,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	Vector of vector of return values
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ evalv() [10/10]

template<class... Args>

void AMP::Materials::Property::evalv	(	std::vector< std::shared_ptr< std::vector< double > > > &	r,
		const Units &	unit,
		const Args &...	args
	)		const

inherited

Evaluate the property.

This function evaluates the property at the desired conditions for multiple points.

Parameters

r	std::vector of return values
unit	The desired units of the result. If this is not specified, the native units of the property are use (see get_units())
args	Optional arguments specifying input arguments to the eval() function. In general arguments are of the form: evalv( r, unit, "arg1", unit1, vec1, "arg2", unit2, vec2, ... ).

◆ get_arg_index()

int AMP::Materials::Property::get_arg_index ( std::string_view name ) const

inlineprotectedinherited

Definition at line 383 of file Property.h.

References AMP::Materials::Property::d_argToIndexMap.

◆ get_arg_range()

std::array< double, 2 > AMP::Materials::Property::get_arg_range ( std::string_view argname ) const

inherited

Get range for a specific argument.

◆ get_arg_ranges()

const auto & AMP::Materials::Property::get_arg_ranges ( ) const

inlineinherited

Get ranges for all arguments used in this material.

Definition at line 149 of file Property.h.

References AMP::Materials::Property::d_ranges.

◆ get_arg_units()

const auto & AMP::Materials::Property::get_arg_units ( ) const

inlineinherited

Get units for all arguments used in this material.

Definition at line 146 of file Property.h.

References AMP::Materials::Property::d_argUnits.

◆ get_argument_index()

int AMP::Materials::Property::get_argument_index ( std::string_view name ) const

inlineinherited

Return the argument index.

Definition at line 87 of file Property.h.

References AMP::Materials::Property::d_arguments.

Referenced by AMP::Materials::Property::set_default().

◆ get_arguments()

const std::vector< std::string > & AMP::Materials::Property::get_arguments ( ) const

inlineinherited

Return the names of the arguments to eval.

Definition at line 81 of file Property.h.

References AMP::Materials::Property::d_arguments.

◆ get_default()

double AMP::Materials::Property::get_default ( std::string_view name ) const

inherited

Get the default for the given argument (NaN if it is an invalid argument)

◆ get_defaults()

const std::vector< double > & AMP::Materials::Property::get_defaults ( ) const

inlineinherited

Get the defaults.

Definition at line 101 of file Property.h.

References AMP::Materials::Property::d_defaults.

◆ get_name()

const std::string & AMP::Materials::Property::get_name ( ) const

inlineinherited

Return name of property.

Definition at line 72 of file Property.h.

References AMP::Materials::Property::d_name.

◆ get_number_arguments()

size_t AMP::Materials::Property::get_number_arguments ( ) const

inlineinherited

Return the number of arguments to eval.

Definition at line 84 of file Property.h.

References AMP::Materials::Property::d_arguments.

◆ get_source()

const std::string & AMP::Materials::Property::get_source ( ) const

inlineinherited

Get the source of the information.

Definition at line 75 of file Property.h.

References AMP::Materials::Property::d_source.

◆ get_units()

const Units & AMP::Materials::Property::get_units ( ) const

inlineinherited

Return source reference.

Definition at line 78 of file Property.h.

References AMP::Materials::Property::d_units.

◆ getAuxiliaryData() [1/2]

const Database & AMP::Materials::Property::getAuxiliaryData ( ) const

inlineinherited

Get auxiliary data.

Definition at line 169 of file Property.h.

References AMP::Materials::Property::d_auxiliaryData.

◆ getAuxiliaryData() [2/2]

template<class TYPE >

TYPE AMP::Materials::Property::getAuxiliaryData ( const std::string & key ) const

inherited

Get auxiliary data.

◆ getSize()

static size_t AMP::Materials::Property::getSize ( const AMP::LinearAlgebra::Vector & )

staticprotectedinherited

◆ getUnits()

static Units AMP::Materials::Property::getUnits ( const AMP::LinearAlgebra::Vector & )

staticprotectedinherited

◆ getValue()

const AMP::Array< double > & AMP::Materials::ScalarProperty::getValue ( ) const

inline

Definition at line 49 of file ScalarProperty.h.

References d_value.

◆ in_range() [1/2]

template<class INPUT_VTYPE >

bool AMP::Materials::Property::in_range	(	std::string_view	argname,
		const INPUT_VTYPE &	values,
		const Units &	unit = `Units()`,
		bool	throwError = `false`
	)		const

inlineinherited

Determine if a set of values are all within range or not.

◆ in_range() [2/2]

bool AMP::Materials::Property::in_range	(	std::string_view	argname,
		double	value,
		const Units &	unit = `Units()`,
		bool	throwError = `false`
	)		const

inlineinherited

Determine if a value is within range or not.

◆ is_argument()

bool AMP::Materials::Property::is_argument ( std::string_view argname ) const

inherited

Determine if a string is an argument.

◆ isScalar()

bool AMP::Materials::Property::isScalar ( ) const

inlineinherited

Indicator for scalar evaluator.

Definition at line 130 of file Property.h.

References AMP::Materials::Property::d_dim, and AMP::ArraySize::length().

◆ isString()

virtual bool AMP::Materials::Property::isString ( ) const

inlinevirtualinherited

Indicator for scalar evaluator.

Reimplemented in AMP::Materials::StringProperty.

Definition at line 127 of file Property.h.

◆ isTensor()

bool AMP::Materials::Property::isTensor ( ) const

inlineinherited

Indicator for tensor evaluator.

Definition at line 136 of file Property.h.

References AMP::Materials::Property::d_dim, and AMP::ArraySize::ndim().

◆ isVector()

bool AMP::Materials::Property::isVector ( ) const

inlineinherited

Indicator for vector evaluator.

Definition at line 133 of file Property.h.

References AMP::Materials::Property::d_dim, AMP::ArraySize::length(), and AMP::ArraySize::ndim().

◆ make_map()

std::map< std::string, std::shared_ptr< AMP::LinearAlgebra::Vector > > AMP::Materials::Property::make_map	(	const std::shared_ptr< AMP::LinearAlgebra::MultiVector > &	args,
		const std::map< std::string, std::string > &	translator
	)		const

inherited

◆ set_default()

void AMP::Materials::Property::set_default	(	std::string_view	name,
		double	value,
		const AMP::Units &	unit = `AMP::Units()`
	)

inlineinherited

Set the default.

Definition at line 105 of file Property.h.

References AMP::Units::convert(), AMP::Materials::Property::d_argUnits, AMP::Materials::Property::d_defaults, AMP::Materials::Property::get_argument_index(), and AMP::Units::isNull().

◆ set_defaults()

void AMP::Materials::Property::set_defaults ( std::vector< double > defaults )

inlineinherited

Set the defaults.

Definition at line 116 of file Property.h.

References AMP_INSIST, AMP::Materials::Property::d_arguments, and AMP::Materials::Property::d_defaults.

◆ setAuxiliaryData()

template<class TYPE >

void AMP::Materials::Property::setAuxiliaryData	(	const std::string &	key,
		const TYPE &	data
	)

inherited

Set auxiliary data.

◆ size()

const ArraySize & AMP::Materials::Property::size ( ) const

inlineinherited

get dimensions of evalv return value

Definition at line 69 of file Property.h.

References AMP::Materials::Property::d_dim.

Member Data Documentation

◆ d_argToIndexMap

std::map<std::string_view, size_t> AMP::Materials::Property::d_argToIndexMap

protectedinherited

map argument names to indices

Definition at line 369 of file Property.h.

Referenced by AMP::Materials::Property::get_arg_index().

◆ d_arguments

std::vector<std::string> AMP::Materials::Property::d_arguments

protectedinherited

names of the arguments

Definition at line 365 of file Property.h.

Referenced by AMP::Materials::Property::get_argument_index(), AMP::Materials::Property::get_arguments(), AMP::Materials::Property::get_number_arguments(), and AMP::Materials::Property::set_defaults().

◆ d_argUnits

std::vector<Units> AMP::Materials::Property::d_argUnits

protectedinherited

default units for the arguments

Definition at line 366 of file Property.h.

Referenced by AMP::Materials::Property::get_arg_units(), and AMP::Materials::Property::set_default().

◆ d_auxiliaryData

AMP::Database AMP::Materials::Property::d_auxiliaryData

protectedinherited

Database containing auxiliary data.

Definition at line 370 of file Property.h.

Referenced by AMP::Materials::Property::getAuxiliaryData().

◆ d_defaults

std::vector<double> AMP::Materials::Property::d_defaults

protectedinherited

default values of arguments

Definition at line 367 of file Property.h.

Referenced by AMP::Materials::Property::get_defaults(), AMP::Materials::Property::set_default(), and AMP::Materials::Property::set_defaults().

◆ d_dim

AMP::ArraySize AMP::Materials::Property::d_dim

protectedinherited

size of the result

Definition at line 362 of file Property.h.

Referenced by AMP::Materials::Property::isScalar(), AMP::Materials::Property::isTensor(), AMP::Materials::Property::isVector(), and AMP::Materials::Property::size().

◆ d_name

std::string AMP::Materials::Property::d_name

protectedinherited

should be unique

Definition at line 361 of file Property.h.

Referenced by AMP::Materials::Property::get_name().

◆ d_ranges

std::vector<std::array<double, 2> > AMP::Materials::Property::d_ranges

protectedinherited

allowed ranges of arguments

Definition at line 368 of file Property.h.

Referenced by AMP::Materials::Property::get_arg_ranges().

◆ d_source

std::string AMP::Materials::Property::d_source

protectedinherited

reference for source data

Definition at line 364 of file Property.h.

Referenced by AMP::Materials::Property::get_source().

◆ d_units

AMP::Units AMP::Materials::Property::d_units

protectedinherited

default units to return

Definition at line 363 of file Property.h.

Referenced by AMP::Materials::Property::get_units().

◆ d_value

AMP::Array<double> AMP::Materials::ScalarProperty::d_value

private

Definition at line 52 of file ScalarProperty.h.

Referenced by getValue().

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

src/materials/ScalarProperty.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScalarProperty() [1/2]

◆ ScalarProperty() [2/2]

Member Function Documentation

◆ checkArgs()

◆ defaultArgs()

◆ eval() [1/3]

◆ eval() [2/3]

◆ eval() [3/3]

◆ evalArg() [1/3]

◆ evalArg() [2/3]

◆ evalArg() [3/3]

◆ evalArgs() [1/12]

◆ evalArgs() [2/12]

◆ evalArgs() [3/12]

◆ evalArgs() [4/12]

◆ evalArgs() [5/12]

◆ evalArgs() [6/12]

◆ evalArgs() [7/12]

◆ evalArgs() [8/12]

◆ evalArgs() [9/12]

◆ evalArgs() [10/12]

◆ evalArgs() [11/12]

◆ evalArgs() [12/12]

◆ evalString()

◆ evalv() [1/10]

◆ evalv() [2/10]

◆ evalv() [3/10]

◆ evalv() [4/10]

◆ evalv() [5/10]

◆ evalv() [6/10]

◆ evalv() [7/10]

◆ evalv() [8/10]

◆ evalv() [9/10]

◆ evalv() [10/10]

◆ get_arg_index()

◆ get_arg_range()

◆ get_arg_ranges()

◆ get_arg_units()

◆ get_argument_index()

◆ get_arguments()

◆ get_default()

◆ get_defaults()

◆ get_name()

◆ get_number_arguments()

◆ get_source()

◆ get_units()

◆ getAuxiliaryData() [1/2]

◆ getAuxiliaryData() [2/2]

◆ getSize()

◆ getUnits()

◆ getValue()

◆ in_range() [1/2]

◆ in_range() [2/2]

◆ is_argument()

◆ isScalar()

◆ isString()

◆ isTensor()

◆ isVector()

◆ make_map()

◆ set_default()

◆ set_defaults()

◆ setAuxiliaryData()

◆ size()

Member Data Documentation

◆ d_argToIndexMap

◆ d_arguments

◆ d_argUnits

◆ d_auxiliaryData

◆ d_defaults

◆ d_dim

◆ d_name

◆ d_ranges

◆ d_source