PolycrystalVoronoiVoidIC initializes either grain or void values for a voronoi tesselation with voids distributed along the grain boundaries. More...

#include <PolycrystalVoronoiVoidIC.h>

Inheritance diagram for PolycrystalVoronoiVoidIC:

[legend]

Classes
struct	DistancePoint
	Type for distance and point. More...

struct	DistancePointComparator
	Sorts the temp_centerpoints into order of magnitude. More...

Public Types
enum	TEST_TYPE

typedef OutputTools< T >::OutputShape	ValueType

typedef OutputTools< T >::OutputGradient	GradientType

typedef OutputTools< T >::OutputShapeGradient	GradientShapeType

typedef OutputTools< T >::OutputData	DataType

typedef FEGenericBase< ValueType >	FEBaseType

typedef DataFileName	DataFileParameterType

Public Member Functions
	PolycrystalVoronoiVoidIC (const InputParameters &parameters)

virtual void	initialSetup () override

virtual MooseVariableFEBase &	variable () override

virtual void	compute () override

virtual void	computeNodal (const Point &p) override

T	gradientComponent (GradientType grad, unsigned int i)

RealVectorValue	gradientComponent (GradientType grad, unsigned int i)

RealEigenVector	gradientComponent (GradientType grad, unsigned int i)

void	setCZeroVertices ()

void	setCZeroVertices ()

void	setHermiteVertices ()

void	setHermiteVertices ()

void	setOtherCOneVertices ()

void	setOtherCOneVertices ()

Real	dotHelper (const RealGradient &op1, const RealGradient &op2)

Real	dotHelper (const RealTensor &op1, const RealTensor &op2)

RealEigenVector	dotHelper (const RealVectorArrayValue &op1, const RealGradient &op2)

void	choleskySolve (bool is_volume)

void	choleskySolve (bool is_volume)

void	choleskyAssembly (bool is_volume)

const std::set< UserObjectName > &	getDependObjects () const

virtual const std::set< std::string > &	getRequestedItems () override

virtual const std::set< std::string > &	getSuppliedItems () override

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &name, const std::string *param=nullptr) const

const std::vector< SubdomainName > &	blocks () const

unsigned int	numBlocks () const

virtual const std::set< SubdomainID > &	blockIDs () const

unsigned int	blocksMaxDimension () const

bool	hasBlocks (const SubdomainName &name) const

bool	hasBlocks (const std::vector< SubdomainName > &names) const

bool	hasBlocks (SubdomainID id) const

bool	hasBlocks (const std::vector< SubdomainID > &ids) const

bool	hasBlocks (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::vector< SubdomainID > &ids) const

bool	hasBlockMaterialProperty (const std::string &prop_name)

const std::set< SubdomainID > &	meshBlockIDs () const

virtual bool	blockRestricted () const

virtual void	checkVariable (const MooseVariableFieldBase &variable) const

const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > &	getCoupledVars () const

const std::vector< MooseVariableFieldBase *> &	getCoupledMooseVars () const

const std::vector< MooseVariable *> &	getCoupledStandardMooseVars () const

const std::vector< VectorMooseVariable *> &	getCoupledVectorMooseVars () const

const std::vector< ArrayMooseVariable *> &	getCoupledArrayMooseVars () const

void	addFEVariableCoupleableVectorTag (TagID tag)

void	addFEVariableCoupleableMatrixTag (TagID tag)

std::set< TagID > &	getFEVariableCoupleableVectorTags ()

const std::set< TagID > &	getFEVariableCoupleableVectorTags () const

std::set< TagID > &	getFEVariableCoupleableMatrixTags ()

const std::set< TagID > &	getFEVariableCoupleableMatrixTags () const

auto &	getWritableCoupledVariables () const

bool	hasWritableCoupledVariables () const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

const ADVectorVariableValue *	getADDefaultVectorValue (const std::string &var_name) const

const ADVariableGradient &	getADDefaultGradient () const

const ADVectorVariableGradient &	getADDefaultVectorGradient () const

const ADVariableSecond &	getADDefaultSecond () const

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase *> >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

bool	getMaterialPropertyCalled () const

const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

virtual const std::set< BoundaryID > &	boundaryIDs () const

const std::vector< BoundaryName > &	boundaryNames () const

unsigned int	numBoundaryIDs () const

bool	hasBoundary (const BoundaryName &name) const

bool	hasBoundary (const std::vector< BoundaryName > &names) const

bool	hasBoundary (const BoundaryID &id) const

bool	hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const

bool	isBoundarySubset (const std::set< BoundaryID > &ids) const

bool	isBoundarySubset (const std::vector< BoundaryID > &ids) const

bool	hasBoundaryMaterialProperty (const std::string &prop_name) const

virtual bool	boundaryRestricted () const

const std::set< BoundaryID > &	meshBoundaryIDs () const

virtual bool	checkVariableBoundaryIntegrity () const

virtual unsigned int	getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const

virtual unsigned int	getElementIDIndexByName (const std::string &id_name) const

virtual const dof_id_type &	getElementID (const std::string &id_parameter_name, unsigned int comp=0) const

dof_id_type	getElementID (const Elem *elem, unsigned int elem_id_index) const

virtual const dof_id_type &	getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const

virtual const dof_id_type &	getElementIDByName (const std::string &id_name) const

virtual const dof_id_type &	getElementIDNeighborByName (const std::string &id_name) const

bool	hasElementID (const std::string &id_name) const

dof_id_type	maxElementID (unsigned int elem_id_index) const

dof_id_type	minElementID (unsigned int elem_id_index) const

bool	areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const

std::unordered_map< dof_id_type, std::set< dof_id_type > >	getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const

std::set< dof_id_type >	getAllElemIDs (unsigned int elem_id_index) const

std::set< dof_id_type >	getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) const

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static InputParameters	actionParameters ()

static bool	restricted (const std::set< BoundaryID > &ids)

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
	ALL

	ANY

const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

Protected Types
enum	ProfileType { ProfileType::COS, ProfileType::TANH }

Protected Member Functions
virtual void	computeCircleCenters () override

virtual Real	value (const Point &p) override

virtual RealGradient	gradient (const Point &p) override

virtual void	computeCircleRadii () override

virtual Real	computeCircleValue (const Point &p, const Point &center, const Real &radius)

virtual RealGradient	computeCircleGradient (const Point &p, const Point &center, const Real &radius)

virtual bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)

void	initializeBlockRestrictable (const MooseObject *moose_object)

Moose::CoordinateSystemType	getBlockCoordSystem ()

virtual void	coupledCallback (const std::string &, bool) const

virtual bool	isCoupled (const std::string &var_name, unsigned int i=0) const

virtual bool	isCoupledConstant (const std::string &var_name) const

unsigned int	coupledComponents (const std::string &var_name) const

VariableName	coupledName (const std::string &var_name, unsigned int comp=0) const

std::vector< VariableName >	coupledNames (const std::string &var_name) const

virtual unsigned int	coupled (const std::string &var_name, unsigned int comp=0) const

std::vector< unsigned int >	coupledIndices (const std::string &var_name) const

virtual const VariableValue &	coupledValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledValues (const std::string &var_name) const

std::vector< const VectorVariableValue *>	coupledVectorValues (const std::string &var_name) const

const GenericVariableValue< is_ad > &	coupledGenericValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericValue (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericValue (const std::string &var_name, unsigned int comp) const

std::vector< const GenericVariableValue< is_ad > *>	coupledGenericValues (const std::string &var_name) const

std::vector< const GenericVariableValue< false > *>	coupledGenericValues (const std::string &var_name) const

std::vector< const GenericVariableValue< true > *>	coupledGenericValues (const std::string &var_name) const

const GenericVariableValue< is_ad > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericDofValue (const std::string &var_name, unsigned int comp) const

virtual const VariableValue &	coupledValueLower (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVariableValue *>	adCoupledValues (const std::string &var_name) const

const ADVariableValue &	adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableValue &	adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVectorVariableValue *>	adCoupledVectorValues (const std::string &var_name) const

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue *>	coupledVectorTagValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const ArrayVariableValue &	coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableValue *>	coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const

std::vector< const ArrayVariableValue *>	coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableGradient &	coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableGradient *>	coupledVectorTagGradients (const std::string &var_names, TagID tag) const

std::vector< const VariableGradient *>	coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const ArrayVariableGradient &	coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const ArrayVariableGradient *>	coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const

std::vector< const ArrayVariableGradient *>	coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

const ArrayVariableValue &	coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledVectorTagDofValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const

virtual const VariableValue &	coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const

std::vector< const VariableValue *>	coupledMatrixTagValues (const std::string &var_names, TagID tag) const

std::vector< const VariableValue *>	coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const

virtual const VectorVariableValue &	coupledVectorValue (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValue (const std::string &var_name, unsigned int comp=0) const

std::vector< const ArrayVariableValue *>	coupledArrayValues (const std::string &var_name) const

MooseWritableVariable &	writableVariable (const std::string &var_name, unsigned int comp=0)

virtual VariableValue &	writableCoupledValue (const std::string &var_name, unsigned int comp=0)

void	checkWritableVar (MooseWritableVariable *var)

virtual const VariableValue &	coupledValueOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledValuesOld (const std::string &var_name) const

virtual const VariableValue &	coupledValueOlder (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledValuesOlder (const std::string &var_name) const

virtual const VariableValue &	coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradient (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableGradient *>	coupledGradients (const std::string &var_name) const

const ADVariableGradient &	adCoupledGradient (const std::string &var_name, unsigned int comp=0) const

const ADVariableGradient &	adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVariableGradient *>	adCoupledGradients (const std::string &var_name) const

const GenericVariableGradient< is_ad > &	coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const

const GenericVariableGradient< false > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

const GenericVariableGradient< true > &	coupledGenericGradient (const std::string &var_name, unsigned int comp) const

std::vector< const GenericVariableGradient< is_ad > *>	coupledGenericGradients (const std::string &var_name) const

std::vector< const GenericVariableGradient< false > *>	coupledGenericGradients (const std::string &var_name) const

std::vector< const GenericVariableGradient< true > *>	coupledGenericGradients (const std::string &var_name) const

const ADVectorVariableGradient &	adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const

const ADVariableSecond &	adCoupledSecond (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableSecond &	adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableGradient *>	coupledGradientsOld (const std::string &var_name) const

virtual const VariableGradient &	coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableGradient &	coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableGradient &	coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableGradient &	coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurl (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurlOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableCurl &	coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDiv (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDivOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableDivergence &	coupledDivOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecond (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const

virtual const VariableSecond &	coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDot (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledDots (const std::string &var_name) const

virtual const VariableValue &	coupledDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledDot (const std::string &var_name, unsigned int comp=0) const

std::vector< const ADVariableValue *>	adCoupledDots (const std::string &var_name) const

const ADVariableValue &	adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const

const ADVectorVariableValue &	adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VectorVariableValue &	coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDot (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const ArrayVariableValue &	coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotDu (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValue (const std::string &var_name, unsigned int comp=0) const

const Moose::ADType< T >::type &	adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const

const T &	coupledNodalDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const

virtual const VariableValue &	coupledDofValues (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledAllDofValues (const std::string &var_name) const

virtual const VariableValue &	coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledAllDofValuesOld (const std::string &var_name) const

virtual const VariableValue &	coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const

std::vector< const VariableValue *>	coupledAllDofValuesOlder (const std::string &var_name) const

virtual const ArrayVariableValue &	coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const

virtual const ADVariableValue &	adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adZeroValue () const

const ADVariableGradient &	adZeroGradient () const

const ADVariableSecond &	adZeroSecond () const

const GenericVariableValue< is_ad > &	genericZeroValue ()

const GenericVariableValue< false > &	genericZeroValue ()

const GenericVariableValue< true > &	genericZeroValue ()

const GenericVariableGradient< is_ad > &	genericZeroGradient ()

const GenericVariableGradient< false > &	genericZeroGradient ()

const GenericVariableGradient< true > &	genericZeroGradient ()

const GenericVariableSecond< is_ad > &	genericZeroSecond ()

const GenericVariableSecond< false > &	genericZeroSecond ()

const GenericVariableSecond< true > &	genericZeroSecond ()

bool	checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const

const MooseVariableFieldBase *	getFEVar (const std::string &var_name, unsigned int comp) const

const MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp) const

MooseVariableFieldBase *	getFieldVar (const std::string &var_name, unsigned int comp)

const T *	getVarHelper (const std::string &var_name, unsigned int comp) const

T *	getVarHelper (const std::string &var_name, unsigned int comp)

MooseVariable *	getVar (const std::string &var_name, unsigned int comp)

const MooseVariable *	getVar (const std::string &var_name, unsigned int comp) const

VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp)

const VectorMooseVariable *	getVectorVar (const std::string &var_name, unsigned int comp) const

ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp)

const ArrayMooseVariable *	getArrayVar (const std::string &var_name, unsigned int comp) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

std::vector< T >	coupledVectorHelper (const std::string &var_name, const Func &func) const

virtual void	checkMaterialProperty (const std::string &name, const unsigned int state)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

bool	hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

Protected Attributes
const MooseEnum	_structure_type

const unsigned int	_op_num

const unsigned int	_op_index

const bool	_columnar_3D

const PolycrystalVoronoi &	_poly_ic_uo

const FileName	_file_name

unsigned int	_grain_num

std::vector< Point >	_centerpoints

struct PolycrystalVoronoiVoidIC::DistancePointComparator	_customLess

const unsigned int	_numbub

const Real	_bubspac

const unsigned int	_max_num_tries

const Real	_radius

const Real	_radius_variation

const MooseEnum	_radius_variation_type

Point	_bottom_left

Point	_top_right

Point	_range

MooseMesh &	_mesh

Real	_invalue

Real	_outvalue

Real	_int_width

bool	_3D_spheres

bool	_zero_gradient

unsigned int	_num_dim

std::vector< Point >	_centers

std::vector< Real >	_radii

enum SmoothCircleBaseIC::ProfileType	_profile

MooseRandom	_random

FEProblemBase &	_fe_problem

THREAD_ID	_tid

Real &	_t

MooseVariableField< T > &	_var

MooseVariableFE< T > *	_fe_var

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const Elem *const &	_current_elem

const Real &	_current_elem_volume

const Node *	_current_node

unsigned int	_qp

DenseMatrix< Real >	_Ke

DenseVector< DataType >	_Fe

DenseVector< DataType >	_Ue

const FEType &	_fe_type

FEContinuity	_cont

std::vector< dof_id_type >	_dof_indices

std::vector< unsigned int >	_side_dofs

unsigned int	_n_qp

unsigned int	_n_nodes

std::vector< char >	_dof_is_fixed

std::vector< int >	_free_dof

dof_id_type	_free_dofs

dof_id_type	_current_dof

dof_id_type	_nc

const std::vector< std::vector< ValueType > > *	_phi

const std::vector< std::vector< GradientShapeType > > *	_dphi

const std::vector< Real > *	_JxW

const std::vector< Point > *	_xyz_values

unsigned int	_n

unsigned int	_dim

SystemBase &	_sys

const bool	_ignore_uo_dependency

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const MaterialData *	_blk_material_data

const InputParameters &	_c_parameters

const std::string &	_c_name

const std::string &	_c_type

FEProblemBase &	_c_fe_problem

const SystemBase *const	_c_sys

std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> >	_coupled_vars

std::vector< MooseVariableFieldBase *>	_coupled_moose_vars

std::vector< MooseVariable *>	_coupled_standard_moose_vars

std::vector< VectorMooseVariable *>	_coupled_vector_moose_vars

std::vector< ArrayMooseVariable *>	_coupled_array_moose_vars

std::vector< MooseVariableFV< Real > *>	_coupled_standard_fv_moose_vars

std::vector< MooseLinearVariableFV< Real > *>	_coupled_standard_linear_fv_moose_vars

const std::unordered_map< std::string, std::string > &	_new_to_deprecated_coupled_vars

bool	_c_nodal

bool	_c_is_implicit

const bool	_c_allow_element_to_nodal_coupling

THREAD_ID	_c_tid

std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > >	_default_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< DualReal > > >	_ad_default_value

std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > >	_default_vector_value

std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > >	_default_array_value

std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > >	_ad_default_vector_value

VariableValue	_default_value_zero

VariableGradient	_default_gradient

MooseArray< ADRealVectorValue >	_ad_default_gradient

MooseArray< ADRealTensorValue >	_ad_default_vector_gradient

VariableSecond	_default_second

MooseArray< ADRealTensorValue >	_ad_default_second

const VariableValue &	_zero

const VariablePhiValue &	_phi_zero

const MooseArray< DualReal > &	_ad_zero

const VariableGradient &	_grad_zero

const MooseArray< ADRealVectorValue > &	_ad_grad_zero

const VariablePhiGradient &	_grad_phi_zero

const VariableSecond &	_second_zero

const MooseArray< ADRealTensorValue > &	_ad_second_zero

const VariablePhiSecond &	_second_phi_zero

const VectorVariableValue &	_vector_zero

const VectorVariableCurl &	_vector_curl_zero

VectorVariableValue	_default_vector_value_zero

VectorVariableGradient	_default_vector_gradient

VectorVariableCurl	_default_vector_curl

VectorVariableDivergence	_default_div

ArrayVariableValue	_default_array_value_zero

ArrayVariableGradient	_default_array_gradient

bool	_coupleable_neighbor

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

PolycrystalVoronoiVoidIC initializes either grain or void values for a voronoi tesselation with voids distributed along the grain boundaries.

Definition at line 24 of file PolycrystalVoronoiVoidIC.h.

Member Enumeration Documentation

◆ ProfileType

enum SmoothCircleBaseIC::ProfileType

strongprotectedinherited

Enumerator
COS
TANH

Definition at line 53 of file SmoothCircleBaseIC.h.

   {
     COS,
     TANH
   } _profile;

Constructor & Destructor Documentation

◆ PolycrystalVoronoiVoidIC()

PolycrystalVoronoiVoidIC::PolycrystalVoronoiVoidIC ( const InputParameters & parameters )

Definition at line 55 of file PolycrystalVoronoiVoidIC.C.

   : MultiSmoothCircleIC(parameters),
     _structure_type(getParam<MooseEnum>("structure_type")),
     _op_num(getParam<unsigned int>("op_num")),
     _op_index(getParam<unsigned int>("op_index")),
     _columnar_3D(getParam<bool>("columnar_3D")),
     _poly_ic_uo(getUserObject<PolycrystalVoronoi>("polycrystal_ic_uo")),
     _file_name(getParam<FileName>("file_name"))
 {
   if (_invalue < _outvalue)
     mooseWarning("Detected invalue < outvalue in PolycrystalVoronoiVoidIC. Please make sure that's "
                  "the intended usage for representing voids.");
   if (_numbub == 0)
     mooseError("PolycrystalVoronoiVoidIC requires numbub > 0. If you want no voids to "
                "be represented, use invalue = outvalue. In general, you should use "
                "PolycrystalVoronoi to represent Voronoi grain structures without "
                "voids.");
 }

Member Function Documentation

◆ actionParameters()

InputParameters PolycrystalVoronoiVoidIC::actionParameters ( )

static

Definition at line 20 of file PolycrystalVoronoiVoidIC.C.

Referenced by PolycrystalVoronoiVoidICAction::validParams(), and validParams().

 {
   InputParameters params = MultiSmoothCircleIC::validParams();
 
   params.addRequiredParam<unsigned int>("op_num", "Number of order parameters");
 
   params.addParam<bool>(
       "columnar_3D", false, "3D microstructure will be columnar in the z-direction?");
 
   return params;
 }

◆ computeCircleCenters()

void PolycrystalVoronoiVoidIC::computeCircleCenters ( )

overrideprotectedvirtual

Reimplemented from MultiSmoothCircleIC.

Definition at line 90 of file PolycrystalVoronoiVoidIC.C.

 {
   _centers.resize(_numbub);
 
   // This Code will place void center points on grain boundaries
   for (unsigned int vp = 0; vp < _numbub; ++vp)
   {
     bool try_again;
     unsigned int num_tries = 0;
 
     do
     {
       try_again = false;
       num_tries++;
 
       if (num_tries > _max_num_tries)
         mooseError("Too many tries of assigning void centers in "
                    "PolycrystalVoronoiVoidIC");
 
       Point rand_point;
 
       for (const auto i : make_range(Moose::dim))
         rand_point(i) = _bottom_left(i) + _range(i) * _random.rand(_tid);
 
       // Allow the vectors to be sorted based on their distance from the
       // rand_point
       std::vector<PolycrystalVoronoiVoidIC::DistancePoint> diff(_grain_num);
 
       for (unsigned int gr = 0; gr < _grain_num; ++gr)
       {
         diff[gr].d = _mesh.minPeriodicDistance(_var.number(), rand_point, _centerpoints[gr]);
         diff[gr].gr = gr;
       }
 
       std::sort(diff.begin(), diff.end(), _customLess);
 
       Point closest_point = _centerpoints[diff[0].gr];
       Point next_closest_point = _centerpoints[diff[1].gr];
 
       // Find Slope of Line in the plane orthogonal to the diff_centerpoint
       // vector
       Point pa = rand_point + _mesh.minPeriodicVector(_var.number(), rand_point, closest_point);
       Point pb =
           rand_point + _mesh.minPeriodicVector(_var.number(), rand_point, next_closest_point);
       Point diff_centerpoints = pb - pa;
 
       Point diff_rand_center = _mesh.minPeriodicVector(_var.number(), closest_point, rand_point);
       Point normal_vector = diff_centerpoints.cross(diff_rand_center);
       Point slope = normal_vector.cross(diff_centerpoints);
 
       // Midpoint position vector between two center points
       Point midpoint = closest_point + (0.5 * diff_centerpoints);
 
       // Solve for the scalar multiplier solution on the line
       Real lambda = 0;
       Point mid_rand_vector = _mesh.minPeriodicVector(_var.number(), midpoint, rand_point);
 
       Real slope_dot = slope * slope;
       mooseAssert(slope_dot > 0, "The dot product of slope with itself is zero");
       for (const auto i : make_range(Moose::dim))
         lambda += (mid_rand_vector(i) * slope(i)) / slope_dot;
 
       // Assigning points to vector
       _centers[vp] = slope * lambda + midpoint;
 
       // Checking to see if points are in the domain ONLY WORKS FOR PERIODIC
       for (const auto i : make_range(Moose::dim))
         if ((_centers[vp](i) > _top_right(i)) || (_centers[vp](i) < _bottom_left(i)))
           try_again = true;
 
       for (unsigned int i = 0; i < vp; ++i)
       {
         Real dist = _mesh.minPeriodicDistance(_var.number(), _centers[vp], _centers[i]);
 
         if (dist < _bubspac)
           try_again = true;
       }
 
       // Two algorithms are available for screening bubbles falling in grain
       // interior. They produce
       // nearly identical results.
       // Here only one is listed. The other one is available upon request.
 
       // Use circle center for checking whether voids are at GBs
       if (try_again == false)
       {
         Real min_rij_1, min_rij_2, rij, rij_diff_tol;
 
         min_rij_1 = _range.norm();
         min_rij_2 = _range.norm();
 
         rij_diff_tol = 0.1 * _radius;
 
         for (unsigned int gr = 0; gr < _grain_num; ++gr)
         {
           rij = _mesh.minPeriodicDistance(_var.number(), _centers[vp], _centerpoints[gr]);
 
           if (rij < min_rij_1)
           {
             min_rij_2 = min_rij_1;
             min_rij_1 = rij;
           }
           else if (rij < min_rij_2)
             min_rij_2 = rij;
         }
 
         if (std::abs(min_rij_1 - min_rij_2) > rij_diff_tol)
           try_again = true;
       }
 
     } while (try_again == true);
   }
 }

◆ computeCircleGradient()

RealGradient SmoothCircleBaseIC::computeCircleGradient	(	const Point &	p,
		const Point &	center,
		const Real &	radius
	)

protectedvirtualinherited

Definition at line 148 of file SmoothCircleBaseIC.C.

Referenced by SmoothCircleBaseIC::gradient().

 {
   Point l_center = center;
   Point l_p = p;
   if (!_3D_spheres) // Create 3D cylinders instead of spheres
   {
     l_p(2) = 0.0;
     l_center(2) = 0.0;
   }
   // Compute the distance between the current point and the center
   Real dist = _mesh.minPeriodicDistance(_var.number(), l_p, l_center);
 
   // early return if we are probing the center of the circle
   if (dist == 0.0)
     return 0.0;
 
   Real DvalueDr = 0.0;
   switch (_profile)
   {
     case ProfileType::COS:
       if (dist < radius + _int_width / 2.0 && dist > radius - _int_width / 2.0)
       {
         const Real int_pos = (dist - radius + _int_width / 2.0) / _int_width;
         const Real Dint_posDr = 1.0 / _int_width;
         DvalueDr = Dint_posDr * (_invalue - _outvalue) *
                    (-std::sin(int_pos * libMesh::pi) * libMesh::pi) / 2.0;
       }
       break;
 
     case ProfileType::TANH:
       DvalueDr = -(_invalue - _outvalue) * 0.5 / _int_width * libMesh::pi *
                  (1.0 - Utility::pow<2>(std::tanh(4.0 * (radius - dist) / _int_width)));
       break;
 
     default:
       mooseError("Internal error.");
   }
 
   return _mesh.minPeriodicVector(_var.number(), center, p) * (DvalueDr / dist);
 }

◆ computeCircleRadii()

void MultiSmoothCircleIC::computeCircleRadii ( )

overrideprotectedvirtualinherited

Implements SmoothCircleBaseIC.

Definition at line 71 of file MultiSmoothCircleIC.C.

 {
   _radii.resize(_numbub);
 
   for (unsigned int i = 0; i < _numbub; i++)
   {
     // Vary bubble radius
     switch (_radius_variation_type)
     {
       case 0: // Uniform distribution
         _radii[i] = _radius * (1.0 + (1.0 - 2.0 * _random.rand(_tid)) * _radius_variation);
         break;
       case 1: // Normal distribution
         _radii[i] = _random.randNormal(_tid, _radius, _radius_variation);
         break;
       case 2: // No variation
         _radii[i] = _radius;
     }
 
     _radii[i] = std::max(_radii[i], 0.0);
   }
 }

◆ computeCircleValue()

Real SmoothCircleBaseIC::computeCircleValue	(	const Point &	p,
		const Point &	center,
		const Real &	radius
	)

protectedvirtualinherited

Reimplemented in RndSmoothCircleIC.

Definition at line 109 of file SmoothCircleBaseIC.C.

Referenced by SmoothCircleBaseIC::gradient(), and SmoothCircleBaseIC::value().

 {
   Point l_center = center;
   Point l_p = p;
   if (!_3D_spheres) // Create 3D cylinders instead of spheres
   {
     l_p(2) = 0.0;
     l_center(2) = 0.0;
   }
   // Compute the distance between the current point and the center
   Real dist = _mesh.minPeriodicDistance(_var.number(), l_p, l_center);
 
   switch (_profile)
   {
     case ProfileType::COS:
     {
       // Return value
       Real value = _outvalue; // Outside circle
 
       if (dist <= radius - _int_width / 2.0) // Inside circle
         value = _invalue;
       else if (dist < radius + _int_width / 2.0) // Smooth interface
       {
         Real int_pos = (dist - radius + _int_width / 2.0) / _int_width;
         value = _outvalue + (_invalue - _outvalue) * (1.0 + std::cos(int_pos * libMesh::pi)) / 2.0;
       }
       return value;
     }
 
     case ProfileType::TANH:
       return (_invalue - _outvalue) * 0.5 * (std::tanh(2.0 * (radius - dist) / _int_width) + 1.0) +
              _outvalue;
 
     default:
       mooseError("Internal error.");
   }
 }

◆ gradient()

RealGradient PolycrystalVoronoiVoidIC::gradient ( const Point & p )

overrideprotectedvirtual

Reimplemented from SmoothCircleBaseIC.

Definition at line 238 of file PolycrystalVoronoiVoidIC.C.

 {
   RealGradient gradient;
   RealGradient void_gradient = MultiSmoothCircleIC::gradient(p);
 
   // Order parameter assignment assumes zero gradient (sharp interface)
   switch (_structure_type)
   {
     case 1: // assigning gradient for voids
       gradient = void_gradient;
       break;
   }
 
   return gradient;
 }

◆ initialSetup()

void PolycrystalVoronoiVoidIC::initialSetup ( )

overridevirtual

Reimplemented from MultiSmoothCircleIC.

Definition at line 75 of file PolycrystalVoronoiVoidIC.C.

 {
   if (_op_num <= _op_index)
     mooseError("op_index is too large in CircleGrainVoidIC");
 
   // Obtain total number and centerpoints of the grains
   _grain_num = _poly_ic_uo.getNumGrains();
   _centerpoints = _poly_ic_uo.getGrainCenters();
 
   // Call initial setup from MultiSmoothCircleIC to create _centers and _radii
   // for voids
   MultiSmoothCircleIC::initialSetup();
 }

◆ validParams()

InputParameters PolycrystalVoronoiVoidIC::validParams ( )

static

Definition at line 35 of file PolycrystalVoronoiVoidIC.C.

 {
   InputParameters params = PolycrystalVoronoiVoidIC::actionParameters();
   MooseEnum structure_options("grains voids");
   params.addRequiredParam<MooseEnum>("structure_type",
                                      structure_options,
                                      "Which structure type is being initialized, grains or voids");
   params.addParam<unsigned int>("op_index",
                                 0,
                                 "The index for the current order parameter, "
                                 "not needed if structure_type = voids");
   params.addRequiredParam<UserObjectName>(
       "polycrystal_ic_uo", "UserObject for obtaining the polycrystal grain structure.");
   params.addParam<FileName>("file_name",
                             "",
                             "File containing grain centroids, if file_name is provided, "
                             "the centroids from the file will be used.");
   return params;
 }

◆ value()

Real PolycrystalVoronoiVoidIC::value ( const Point & p )

overrideprotectedvirtual

Reimplemented from SmoothCircleBaseIC.

Definition at line 205 of file PolycrystalVoronoiVoidIC.C.

 {
   Real value = 0.0;
 
   // Determine value for voids
   Real void_value = MultiSmoothCircleIC::value(p);
 
   // Determine value for grains
   Real grain_value = _poly_ic_uo.getVariableValue(_op_index, p);
 
   switch (_structure_type)
   {
     case 0:                 // assigning values for grains (order parameters)
       if (grain_value == 0) // Not in this grain
         value = grain_value;
       else                             // in this grain, but might be in a void
           if (void_value == _outvalue) // Not in a void
         value = grain_value;
       else if (void_value > _outvalue && void_value < _invalue) // On void interface
         value = grain_value * (_invalue - void_value) / (_invalue - _outvalue);
       else if (void_value == _invalue) // In a void, so op = 0
         value = 0.0;
       break;
 
     case 1: // assigning values for voids (concentration)
       value = void_value;
       break;
   }
 
   return value;
 }

Member Data Documentation

◆ _3D_spheres

bool SmoothCircleBaseIC::_3D_spheres

protectedinherited

Definition at line 45 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), and SmoothCircleBaseIC::computeCircleValue().

◆ _bottom_left

Point MultiSmoothCircleIC::_bottom_left

protectedinherited

Definition at line 43 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), and MultiSmoothCircleIC::initialSetup().

◆ _bubspac

const Real MultiSmoothCircleIC::_bubspac

protectedinherited

Definition at line 35 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), and computeCircleCenters().

◆ _centerpoints

std::vector<Point> PolycrystalVoronoiVoidIC::_centerpoints

protected

Definition at line 53 of file PolycrystalVoronoiVoidIC.h.

Referenced by computeCircleCenters(), and initialSetup().

◆ _centers

std::vector<Point> SmoothCircleBaseIC::_centers

protectedinherited

Definition at line 50 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleIC::computeCircleCenters(), SpecifiedSmoothCircleIC::computeCircleCenters(), LatticeSmoothCircleIC::computeCircleCenters(), ClosePackIC::computeCircleCenters(), SmoothCircleFromFileIC::computeCircleCenters(), MultiSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), SmoothCircleBaseIC::gradient(), SmoothCircleBaseIC::initialSetup(), and SmoothCircleBaseIC::value().

◆ _columnar_3D

const bool PolycrystalVoronoiVoidIC::_columnar_3D

protected

Definition at line 41 of file PolycrystalVoronoiVoidIC.h.

◆ _customLess

struct PolycrystalVoronoiVoidIC::DistancePointComparator PolycrystalVoronoiVoidIC::_customLess

protected

Referenced by computeCircleCenters().

◆ _file_name

const FileName PolycrystalVoronoiVoidIC::_file_name

protected

Definition at line 45 of file PolycrystalVoronoiVoidIC.h.

◆ _grain_num

unsigned int PolycrystalVoronoiVoidIC::_grain_num

protected

Definition at line 52 of file PolycrystalVoronoiVoidIC.h.

Referenced by computeCircleCenters(), and initialSetup().

◆ _int_width

Real SmoothCircleBaseIC::_int_width

protectedinherited

Definition at line 44 of file SmoothCircleBaseIC.h.

Referenced by LatticeSmoothCircleIC::computeCircleCenters(), SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _invalue

Real SmoothCircleBaseIC::_invalue

protectedinherited

Definition at line 42 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), SmoothCircleBaseIC::gradient(), PolycrystalVoronoiVoidIC(), SmoothCircleBaseIC::value(), and value().

◆ _max_num_tries

const unsigned int MultiSmoothCircleIC::_max_num_tries

protectedinherited

Definition at line 37 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), and computeCircleCenters().

◆ _mesh

MooseMesh& SmoothCircleBaseIC::_mesh

protectedinherited

Definition at line 40 of file SmoothCircleBaseIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), LatticeSmoothCircleIC::initialSetup(), and MultiSmoothCircleIC::initialSetup().

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim

protectedinherited

Definition at line 48 of file SmoothCircleBaseIC.h.

◆ _numbub

const unsigned int MultiSmoothCircleIC::_numbub

protectedinherited

Definition at line 34 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), MultiSmoothCircleIC::computeCircleRadii(), and PolycrystalVoronoiVoidIC().

◆ _op_index

const unsigned int PolycrystalVoronoiVoidIC::_op_index

protected

Definition at line 39 of file PolycrystalVoronoiVoidIC.h.

Referenced by initialSetup(), and value().

◆ _op_num

const unsigned int PolycrystalVoronoiVoidIC::_op_num

protected

Definition at line 38 of file PolycrystalVoronoiVoidIC.h.

Referenced by initialSetup().

◆ _outvalue

Real SmoothCircleBaseIC::_outvalue

protectedinherited

Definition at line 43 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), SmoothCircleBaseIC::gradient(), PolycrystalVoronoiVoidIC(), SmoothCircleBaseIC::value(), and value().

◆ _poly_ic_uo

const PolycrystalVoronoi& PolycrystalVoronoiVoidIC::_poly_ic_uo

protected

Definition at line 43 of file PolycrystalVoronoiVoidIC.h.

Referenced by initialSetup(), and value().

◆ _profile

enum SmoothCircleBaseIC::ProfileType SmoothCircleBaseIC::_profile

protectedinherited

Referenced by SmoothCircleBaseIC::computeCircleGradient(), SmoothCircleBaseIC::computeCircleValue(), RndSmoothCircleIC::RndSmoothCircleIC(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _radii

std::vector<Real> SmoothCircleBaseIC::_radii

protectedinherited

Definition at line 51 of file SmoothCircleBaseIC.h.

Referenced by LatticeSmoothCircleIC::computeCircleCenters(), ClosePackIC::computeCircleCenters(), SpecifiedSmoothCircleIC::computeCircleRadii(), SmoothCircleIC::computeCircleRadii(), LatticeSmoothCircleIC::computeCircleRadii(), SmoothCircleFromFileIC::computeCircleRadii(), MultiSmoothCircleIC::computeCircleRadii(), SmoothCircleBaseIC::gradient(), SmoothCircleBaseIC::initialSetup(), and SmoothCircleBaseIC::value().

◆ _radius

const Real MultiSmoothCircleIC::_radius

protectedinherited

Definition at line 39 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), and MultiSmoothCircleIC::computeCircleRadii().

◆ _radius_variation

const Real MultiSmoothCircleIC::_radius_variation

protectedinherited

Definition at line 40 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleRadii(), and MultiSmoothCircleIC::initialSetup().

◆ _radius_variation_type

const MooseEnum MultiSmoothCircleIC::_radius_variation_type

protectedinherited

Definition at line 41 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleRadii(), and MultiSmoothCircleIC::initialSetup().

◆ _random

MooseRandom SmoothCircleBaseIC::_random

protectedinherited

Definition at line 59 of file SmoothCircleBaseIC.h.

Referenced by LatticeSmoothCircleIC::computeCircleCenters(), MultiSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), LatticeSmoothCircleIC::computeCircleRadii(), MultiSmoothCircleIC::computeCircleRadii(), RndSmoothCircleIC::computeCircleValue(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _range

Point MultiSmoothCircleIC::_range

protectedinherited

Definition at line 45 of file MultiSmoothCircleIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), and MultiSmoothCircleIC::initialSetup().

◆ _structure_type

const MooseEnum PolycrystalVoronoiVoidIC::_structure_type

protected

Definition at line 36 of file PolycrystalVoronoiVoidIC.h.

Referenced by gradient(), and value().

◆ _top_right

Point MultiSmoothCircleIC::_top_right

protectedinherited

Definition at line 44 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), and MultiSmoothCircleIC::initialSetup().

◆ _zero_gradient

bool SmoothCircleBaseIC::_zero_gradient

protectedinherited

Definition at line 46 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::gradient().

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

phase_field/include/ics/PolycrystalVoronoiVoidIC.h
phase_field/src/ics/PolycrystalVoronoiVoidIC.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ProfileType

Constructor & Destructor Documentation

◆ PolycrystalVoronoiVoidIC()

Member Function Documentation

◆ actionParameters()

◆ computeCircleCenters()

◆ computeCircleGradient()

◆ computeCircleRadii()

◆ computeCircleValue()

◆ gradient()

◆ initialSetup()

◆ validParams()

◆ value()

Member Data Documentation

◆ _3D_spheres

◆ _bottom_left

◆ _bubspac

◆ _centerpoints

◆ _centers

◆ _columnar_3D

◆ _customLess

◆ _file_name

◆ _grain_num

◆ _int_width

◆ _invalue

◆ _max_num_tries

◆ _mesh

◆ _num_dim

◆ _numbub

◆ _op_index

◆ _op_num

◆ _outvalue

◆ _poly_ic_uo

◆ _profile

◆ _radii

◆ _radius

◆ _radius_variation

◆ _radius_variation_type

◆ _random

◆ _range

◆ _structure_type

◆ _top_right

◆ _zero_gradient