Interface class to return the size of material properties that do not have a fixed size. More...

#include <VariableSizeMaterialPropertiesInterface.h>

Inheritance diagram for VariableSizeMaterialPropertiesInterface:

Public Member Functions
	VariableSizeMaterialPropertiesInterface (const InputParameters &)

virtual std::size_t	getVectorPropertySize (const MaterialPropertyName &prop_name) const
	Return the size of the variable size vector material property that the material defines.

virtual std::pair< std::size_t, std::size_t >	getMatrixPropertySize (const MaterialPropertyName &prop_name) const
	Return the number of rows and columns of the variable size matrix material property that the material defines.

Detailed Description

Interface class to return the size of material properties that do not have a fixed size.

Definition at line 19 of file VariableSizeMaterialPropertiesInterface.h.

Constructor & Destructor Documentation

◆ VariableSizeMaterialPropertiesInterface()

VariableSizeMaterialPropertiesInterface::VariableSizeMaterialPropertiesInterface ( const InputParameters & )

inline

Definition at line 22 of file VariableSizeMaterialPropertiesInterface.h.

22{}

Member Function Documentation

◆ getMatrixPropertySize()

std::pair< std::size_t, std::size_t > VariableSizeMaterialPropertiesInterface::getMatrixPropertySize ( const MaterialPropertyName & prop_name ) const

virtual

Return the number of rows and columns of the variable size matrix material property that the material defines.

Materials that declare such a property must override this; the default errors.

Reimplemented in GenericConstant2DArrayTempl< is_ad >.

Definition at line 23 of file VariableSizeMaterialPropertiesInterface.C.

{
  mooseError("getMatrixPropertySize() is not implemented for the material declaring property '",
             prop_name,
             "'");
}

Referenced by Moose::checkArrayMaterialPropertySize().

◆ getVectorPropertySize()

std::size_t VariableSizeMaterialPropertiesInterface::getVectorPropertySize ( const MaterialPropertyName & prop_name ) const

virtual

Return the size of the variable size vector material property that the material defines.

Materials that declare such a property must override this; the default errors.

Reimplemented in GenericConstantArray, and GenericConstantStdVectorMaterialTempl< is_ad >.

Definition at line 14 of file VariableSizeMaterialPropertiesInterface.C.

{
  mooseError("getVectorPropertySize() is not implemented for the material declaring property '",
             prop_name,
             "'");
}

Referenced by MaterialOutputAction::outputHelper().

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