Adaptivity

Adaptivity/Markers

AuxKernels

AuxKernels/MatVecRealGradAuxKernel

AuxKernels/MaterialVectorAuxKernel

AuxKernels/MaterialVectorGradAuxKernel

AuxVariables

AuxVariables/MultiAuxVariables

  • Phase Field App
  • MultiAuxVariablesActionSet up auxvariables for components of MaterialProperty<std::vector<data_type> > for polycrystal sample.

Functions

  • Phase Field App
  • FourierNoiseGenerate noise from a fourier series

ICs

ICs/PolycrystalICs

ICs/PolycrystalICs/BicrystalBoundingBoxIC

  • Phase Field App
  • BicrystalBoundingBoxICActionConstructs a bicrystal, where one grain is on the inside of the box and the other grain is the outside of the box

ICs/PolycrystalICs/BicrystalCircleGrainIC

ICs/PolycrystalICs/PolycrystalColoringIC

ICs/PolycrystalICs/PolycrystalRandomIC

ICs/PolycrystalICs/PolycrystalVoronoiVoidIC

ICs/PolycrystalICs/Tricrystal2CircleGrainsIC

InterfaceKernels

Kernels

  • Phase Field App
  • ACBarrierFunctionAllen-Cahn kernel used when 'mu' is a function of variables
  • ACGBPolyGrain-Boundary model concentration dependent residual
  • ACGrGrElasticDrivingForceAdds elastic energy contribution to the Allen-Cahn equation
  • ACGrGrMultiMulti-phase poly-crystalline Allen-Cahn Kernel
  • ACGrGrPolyGrain-Boundary model poly-crystalline interface Allen-Cahn Kernel
  • ACGrGrPolyLinearizedInterfaceGrain growth model Allen-Cahn Kernel with linearized interface variable transformation
  • ACInterfaceGradient energy Allen-Cahn Kernel
  • ACInterface2DMultiPhase1Gradient energy Allen-Cahn Kernel where the derivative of interface parameter kappa wrt the gradient of order parameter is considered.
  • ACInterface2DMultiPhase2Gradient energy Allen-Cahn Kernel where the interface parameter kappa is considered.
  • ACInterfaceChangedVariableGradient energy Allen-Cahn Kernel using a change of variable
  • ACInterfaceCleavageFractureGradient energy Allen-Cahn Kernel where crack propagation along weakcleavage plane is preferred
  • ACInterfaceKobayashi1Anisotropic gradient energy Allen-Cahn Kernel Part 1
  • ACInterfaceKobayashi2Anisotropic Gradient energy Allen-Cahn Kernel Part 2
  • ACInterfaceStressInterface stress driving force Allen-Cahn Kernel
  • ACKappaFunctionGradient energy term for when kappa as a function of the variable
  • ACMultiInterfaceGradient energy Allen-Cahn Kernel with cross terms
  • ACSEDGPolyStored Energy contribution to grain growth
  • ACSwitchingKernel for Allen-Cahn equation that adds derivatives of switching functions and energies
  • ADACBarrierFunctionAllen-Cahn kernel used when 'mu' is a function of variables
  • ADACGrGrMultiMulti-phase poly-crystalline Allen-Cahn Kernel
  • ADACInterfaceGradient energy Allen-Cahn Kernel
  • ADACInterfaceKobayashi1Anisotropic gradient energy Allen-Cahn Kernel Part 1
  • ADACInterfaceKobayashi2Anisotropic Gradient energy Allen-Cahn Kernel Part 2
  • ADACKappaFunctionGradient energy term for when kappa as a function of the variable
  • ADACSwitchingKernel for Allen-Cahn equation that adds derivatives of switching functions and energies
  • ADAllenCahnAllen-Cahn Kernel that uses a DerivativeMaterial Free Energy
  • ADCHSoretMobilityAdds contribution due to thermo-migration to the Cahn-Hilliard equation using a concentration 'u', temperature 'T', and thermal mobility 'mobility' (in units of length squared per time).
  • ADCHSplitChemicalPotentialChemical potential kernel in Split Cahn-Hilliard that solves chemical potential in a weak form
  • ADCHSplitConcentrationConcentration kernel in Split Cahn-Hilliard that solves chemical potential in a weak form
  • ADCoefCoupledTimeDerivativeScaled time derivative Kernel that acts on a coupled variable
  • ADCoupledSwitchingTimeDerivativeCoupled time derivative Kernel that multiplies the time derivative by
  • ADGrainGrowthGrain-Boundary model poly-crystalline interface Allen-Cahn Kernel
  • ADMatAnisoDiffusionDiffusion equation kernel that takes an anisotropic diffusivity from a material property
  • ADSplitCHParsedSplit formulation Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy
  • ADSplitCHWResSplit formulation Cahn-Hilliard Kernel for the chemical potential variable with a scalar (isotropic) mobility
  • ADSplitCHWResAnisoSplit formulation Cahn-Hilliard Kernel for the chemical potential variable with a scalar (isotropic) mobility
  • ADSusceptibilityTimeDerivativeA modified time derivative Kernel that multiplies the time derivative of a variable by a generalized susceptibility
  • AllenCahnAllen-Cahn Kernel that uses a DerivativeMaterial Free Energy
  • AllenCahnElasticEnergyOffDiagThis kernel calculates off-diagonal Jacobian of elastic energy in AllenCahn with respect to displacements
  • AntitrappingCurrentKernel that provides antitrapping current at the interface for alloy solidification
  • CHBulkPFCTradCahn-Hilliard kernel for a polynomial phase field crystal free energy.
  • CHInterfaceGradient energy Cahn-Hilliard Kernel with a scalar (isotropic) mobility
  • CHInterfaceAnisoGradient energy Cahn-Hilliard Kernel with a tensor (anisotropic) mobility
  • CHMathSimple demonstration Cahn-Hilliard Kernel using an algebraic double-well potential
  • CHPFCRFFCahn-Hilliard residual for the RFF form of the phase field crystal model
  • CHSplitChemicalPotentialChemical potential kernel in Split Cahn-Hilliard that solves chemical potential in a weak form
  • CHSplitConcentrationConcentration kernel in Split Cahn-Hilliard that solves chemical potential in a weak form
  • CHSplitFluxComputes flux as nodal variable
  • CahnHilliardCahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy and a scalar (isotropic) mobility
  • CahnHilliardAnisoCahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy and a tensor (anisotropic) mobility
  • ChangedVariableTimeDerivativeA modified time derivative Kernel that multiplies the time derivative bythe derivative of the nonlinear preconditioning function
  • CoefCoupledTimeDerivativeScaled time derivative Kernel that acts on a coupled variable
  • ConservedLangevinNoiseSource term for noise from a ConservedNoise userobject
  • CoupledAllenCahnCoupled Allen-Cahn Kernel that uses a DerivativeMaterial Free Energy
  • CoupledMaterialDerivativeKernel that implements the first derivative of a function material property with respect to a coupled variable.
  • CoupledSusceptibilityTimeDerivativeA modified coupled time derivative Kernel that multiplies the time derivative of a coupled variable by a generalized susceptibility
  • CoupledSwitchingTimeDerivativeCoupled time derivative Kernel that multiplies the time derivative by
  • DiscreteNucleationForceTerm for inserting grain nuclei or phases in non-conserved order parameter fields
  • GradientComponentSet the kernel variable to a specified component of the gradient of a coupled variable.
  • HHPFCRFFReaction type kernel for the RFF phase fit crystal model
  • KKSACBulkCKKS model kernel (part 2 of 2) for the Bulk Allen-Cahn. This includes all terms dependent on chemical potential.
  • KKSACBulkFKKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential.
  • KKSCHBulkKKS model kernel for the Bulk Cahn-Hilliard term. This operates on the concentration 'c' as the non-linear variable
  • KKSMultiACBulkCMulti-phase KKS model kernel (part 2 of 2) for the Bulk Allen-Cahn. This includes all terms dependent on chemical potential.
  • KKSMultiACBulkFKKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential.
  • KKSMultiPhaseConcentrationKKS multi-phase model kernel to enforce . The non-linear variable of this kernel is , the final phase concentration in the list.
  • KKSPhaseChemicalPotentialKKS model kernel to enforce the pointwise equality of phase chemical potentials . The non-linear variable of this kernel is .
  • KKSPhaseConcentrationKKS model kernel to enforce the decomposition of concentration into phase concentration . The non-linear variable of this kernel is .
  • KKSSplitCHCResKKS model kernel for the split Bulk Cahn-Hilliard term. This kernel operates on the physical concentration 'c' as the non-linear variable
  • LangevinNoiseSource term for non-conserved Langevin noise
  • LaplacianSplitSplit with a variable that holds the Laplacian of a phase field variable.
  • MaskedBodyForceKernel that defines a body force modified by a material mask
  • MaskedExponentialKernel to add dilute solution term to Poisson's equation for electrochemical sintering
  • MatAnisoDiffusionDiffusion equation Kernel that takes an anisotropic Diffusivity from a material property
  • MatGradSquareCoupledGradient square of a coupled variable.
  • MultiGrainRigidBodyMotionAdds rigid body motion to grains
  • NestedKKSACBulkCKKS model kernel (part 2 of 2) for the Bulk Allen-Cahn. This includes all terms dependent on chemical potential.
  • NestedKKSACBulkFKKS model kernel (part 1 of 2) for the Bulk Allen-Cahn. This includes all terms NOT dependent on chemical potential.
  • NestedKKSSplitCHCResKKS model kernel for the split Bulk Cahn-Hilliard term. This kernel operates on the physical concentration 'c' as the non-linear variable.
  • SLKKSChemicalPotentialSLKKS model kernel to enforce the pointwise equality of sublattice chemical potentials in the same phase.
  • SLKKSMultiACBulkCMulti-phase SLKKS model kernel for the bulk Allen-Cahn. This includes all terms dependent on chemical potential.
  • SLKKSMultiPhaseConcentrationSLKKS multi-phase model kernel to enforce . The non-linear variable of this kernel is a phase's sublattice concentration
  • SLKKSPhaseConcentrationSublattice KKS model kernel to enforce the decomposition of concentration into phase and sublattice concentrations The non-linear variable of this kernel is a sublattice concentration of phase b.
  • SLKKSSumEnforce the sum of sublattice concentrations to a given phase concentration.
  • SimpleACInterfaceGradient energy for Allen-Cahn Kernel with constant Mobility and Interfacial parameter
  • SimpleCHInterfaceGradient energy for Cahn-Hilliard equation with constant Mobility and Interfacial parameter
  • SimpleCoupledACInterfaceGradient energy for Allen-Cahn Kernel with constant Mobility and Interfacial parameter for a coupled order parameter variable.
  • SimpleSplitCHWResGradient energy for split Cahn-Hilliard equation with constant Mobility for a coupled order parameter variable.
  • SingleGrainRigidBodyMotionAdds rigid mody motion to a single grain
  • SoretDiffusionAdd Soret effect to Split formulation Cahn-Hilliard Kernel
  • SplitCHMathSimple demonstration split formulation Cahn-Hilliard Kernel using an algebraic double-well potential
  • SplitCHParsedSplit formulation Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy
  • SplitCHWResSplit formulation Cahn-Hilliard Kernel for the chemical potential variable with a scalar (isotropic) mobility
  • SplitCHWResAnisoSplit formulation Cahn-Hilliard Kernel for the chemical potential variable with a tensor (anisotropic) mobility
  • SusceptibilityTimeDerivativeA modified time derivative Kernel that multiplies the time derivative of a variable by a generalized susceptibility
  • SwitchingFunctionConstraintEtaLagrange multiplier kernel to constrain the sum of all switching functions in a multiphase system. This kernel acts on a non-conserved order parameter eta_i.
  • SwitchingFunctionConstraintLagrangeLagrange multiplier kernel to constrain the sum of all switching functions in a multiphase system. This kernel acts on the Lagrange multiplier variable.
  • SwitchingFunctionPenaltyPenalty kernel to constrain the sum of all switching functions in a multiphase system.
  • CHPFCRFFSplitKernel
  • HHPFCRFFSplitKernel
  • PFCRFFKernel
  • PolycrystalElasticDrivingForce
  • PolycrystalKernel
  • PolycrystalStoredEnergy
  • RigidBodyMultiKernel

Kernels/CHPFCRFFSplitKernel

Kernels/HHPFCRFFSplitKernel

Kernels/PFCRFFKernel

  • Phase Field App
  • PFCRFFKernelActionSet up kernels for the rational function fit (RFF) phase field crystal model

Kernels/PolycrystalElasticDrivingForce

Kernels/PolycrystalKernel

Kernels/PolycrystalStoredEnergy

  • Phase Field App
  • PolycrystalStoredEnergyActionAction that adds the contribution of stored energy associated with dislocations to grain growth models

Kernels/RigidBodyMultiKernel

Materials

  • Phase Field App
  • ADConstantAnisotropicMobilityProvide a constant mobility tensor value
  • ADGBEvolutionComputes necessary material properties for the isotropic grain growth model
  • ADInterfaceOrientationMaterial2D interfacial anisotropy
  • ADMathCTDFreeEnergyMaterial that implements the math free energy using the expression builder and automatic differentiation
  • ADMathFreeEnergyMaterial that implements the math free energy and its derivatives:
  • ADSwitchingFunctionMultiPhaseMaterialCalculates the switching function for a given phase for a multi-phase, multi-order parameter model
  • AsymmetricCrossTermBarrierFunctionMaterialFree energy contribution asymmetric across interfaces between arbitrary pairs of phases.
  • BarrierFunctionMaterialHelper material to provide and its derivative in a polynomial. SIMPLE: LOW: HIGH:
  • CompositeMobilityTensorAssemble a mobility tensor from multiple tensor contributions weighted by material properties
  • ComputeGBMisorientationTypeCalculate types of grain boundaries in a polycrystalline sample
  • ComputePolycrystalElasticityTensorCompute an evolving elasticity tensor coupled to a grain growth phase field model.
  • ConstantAnisotropicMobilityProvide a constant mobility tensor value
  • CoupledValueFunctionFreeEnergyCompute a free energy from a lookup function
  • CrossTermBarrierFunctionMaterialFree energy contribution symmetric across interfaces between arbitrary pairs of phases.
  • DeformedGrainMaterial
  • DerivativeMultiPhaseMaterialTwo phase material that combines n phase materials using a switching function with and n non-conserved order parameters (to be used with SwitchingFunctionConstraint*).
  • DerivativeTwoPhaseMaterialTwo phase material that combines two single phase materials using a switching function.
  • DiscreteNucleationFree energy contribution for nucleating discrete particles
  • ElasticEnergyMaterialFree energy material for the elastic energy contributions.
  • ElectrochemicalDefectMaterialCalculates density, susceptibility, and derivatives for a defect species in the grand potential sintering model coupled with electrochemistry
  • ElectrochemicalSinteringMaterialIncludes switching and thermodynamic properties for the grand potential sintering model coupled with electrochemistry
  • ExternalForceDensityMaterialProviding external applied force density to grains
  • ForceDensityMaterialCalculating the force density acting on a grain
  • GBAnisotropy
  • GBDependentAnisotropicTensorCompute anisotropic rank two tensor based on GB phase variable
  • GBDependentDiffusivityCompute diffusivity rank two tensor based on GB phase variable
  • GBEvolutionComputes necessary material properties for the isotropic grain growth model
  • GBWidthAnisotropy
  • GrainAdvectionVelocityCalculation the advection velocity of grain due to rigid body translation and rotation
  • GrandPotentialInterfaceCalculate Grand Potential interface parameters for a specified interfacial free energy and width
  • GrandPotentialSinteringMaterialIncludes switching and thermodynamic properties for the grand potential sintering model
  • GrandPotentialTensorMaterialDiffusion and mobility parameters for grand potential model governing equations. Uses a tensor diffusivity
  • IdealGasFreeEnergyFree energy of an ideal gas.
  • InterfaceOrientationMaterial2D interfacial anisotropy
  • InterfaceOrientationMultiphaseMaterialThis Material accounts for the the orientation dependence of interfacial energy for multi-phase multi-order parameter phase-field model.
  • KKSPhaseConcentrationDerivativesComputes the KKS phase concentration derivatives wrt global concentrations and order parameters, which are used in the chain rules in the KKS kernels. This class is intended to be used with KKSPhaseConcentrationMaterial.
  • KKSPhaseConcentrationMaterialComputes the KKS phase concentrations by using nested Newton iteration to solve the equal chemical potential and concentration conservation equations. This class is intended to be used with KKSPhaseConcentrationDerivatives.
  • KKSXeVacSolidMaterialKKS Solid phase free energy for Xe,Vac in UO2. Fm(cmg,cmv)
  • LinearizedInterfaceFunctionDefines the order parameter substitution for linearized interface phase field models
  • MathCTDFreeEnergyMaterial that implements the math free energy using the expression builder and automatic differentiation
  • MathEBFreeEnergyMaterial that implements the math free energy using the expression builder and automatic differentiation
  • MathFreeEnergyMaterial that implements the math free energy and its derivatives:
  • MixedSwitchingFunctionMaterialHelper material to provide h(eta) and its derivative in one of two polynomial forms. MIX234 and MIX246
  • MultiBarrierFunctionMaterialDouble well phase transformation barrier free energy contribution.
  • PFCRFFMaterial
  • PFCTradMaterialPolynomial coefficients for a phase field crystal correlation function
  • PFParamsPolyFreeEnergyPhase field parameters for polynomial free energy for single component systems
  • PhaseNormalTensorCalculate normal tensor of a phase based on gradient
  • PolycrystalDiffusivityGenerates a diffusion coefficient to distinguish between the bulk, pore, grain boundaries, and surfaces
  • PolycrystalDiffusivityTensorBaseGenerates a diffusion tensor to distinguish between the bulk, grain boundaries, and surfaces
  • PolynomialFreeEnergyPolynomial free energy for single component systems
  • RegularSolutionFreeEnergyMaterial that implements the free energy of a regular solution
  • StrainGradDispDerivativesProvide the constant derivatives of strain w.r.t. the displacement gradient components.
  • SwitchingFunction3PhaseMaterialMaterial for switching function that prevents formation of a third phase at a two-phase interface:
  • SwitchingFunctionMaterialHelper material to provide and its derivative in one of two polynomial forms. SIMPLE: HIGH:
  • SwitchingFunctionMultiPhaseMaterialCalculates the switching function for a given phase for a multi-phase, multi-order parameter model
  • ThirdPhaseSuppressionMaterialFree Energy contribution that penalizes more than two order parameters being non-zero
  • TimeStepMaterialProvide various time stepping quantities as material properties.
  • VanDerWaalsFreeEnergyFree energy of a Van der Waals gas.
  • VariableGradientMaterialCompute the norm of the gradient of a variable

Mesh

  • Phase Field App
  • EBSDMeshGeneratorMesh generated from a specified DREAM.3D EBSD data file.
  • SphereSurfaceMeshGeneratorGenerated sphere mesh - a two dimensional manifold embedded in three dimensional space
  • EBSDMeshMesh generated from a specified DREAM.3D EBSD data file.

Modules

Modules/PhaseField

Modules/PhaseField/Conserved

  • Phase Field App
  • ConservedActionSet up the variable(s) and the kernels needed for a conserved phase field variable. Note that for a direct solve, the element family and order are overwritten with hermite and third.

Modules/PhaseField/DisplacementGradients

  • Phase Field App
  • DisplacementGradientsActionSet up variables, kernels, and materials for a the displacement gradients and their elastic free energy derivatives for non-split Cahn-Hilliard problems.

Modules/PhaseField/EulerAngles2RGB

  • Phase Field App
  • EulerAngle2RGBActionSet up auxvariables and auxkernels to output Euler angles as RGB values interpolated across inverse pole figure

Modules/PhaseField/GrainGrowth

  • Phase Field App
  • GrainGrowthActionSet up the variable and the kernels needed for a grain growth simulation

Modules/PhaseField/GrainGrowthLinearizedInterface

Modules/PhaseField/GrandPotential

Modules/PhaseField/Nonconserved

  • Phase Field App
  • NonconservedActionSet up the variable and the kernels needed for a non-conserved phase field variable

Postprocessors

UserObjects

  • Phase Field App
  • ComputeExternalGrainForceAndTorqueUserobject for calculating force and torque acting on a grain
  • ComputeGrainForceAndTorqueUserobject for calculating force and torque acting on a grain
  • ConservedMaskedNormalNoiseGaussian normal distributed random number noise provider with an applied spatially dependent material property mask for the ConservedLangevinNoise kernel.
  • ConservedMaskedUniformNoiseUniformly distributed random number noise provider with an applied spatially dependent material property mask for the ConservedLangevinNoise kernel.
  • ConservedNormalNoiseGaussian normal distributed random number noise provider for the ConservedLangevinNoise kernel.
  • ConservedUniformNoiseUniformly distributed random number noise provider for the ConservedLangevinNoise kernel.
  • ConstantGrainForceAndTorqueUserobject for calculating force and torque acting on a grain
  • DiscreteNucleationFromFileManages the list of currently active nucleation sites and adds new sites according to a predetermined list from a CSV file (use this with sync_times).
  • DiscreteNucleationInserterManages the list of currently active nucleation sites and adds new sites according to a given probability function.
  • DiscreteNucleationMapGenerates a spatial smoothed map of all nucleation sites with the data of the DiscreteNucleationInserter for use by the DiscreteNucleation material.
  • EBSDReaderLoad and manage DREAM.3D EBSD data files for running simulations on reconstructed microstructures.
  • EulerAngleUpdaterProvide updated euler angles after rigid body rotation of the grains.
  • GrainForceAndTorqueSumUserobject for summing forces and torques acting on a grain
  • MaskedGrainForceAndTorqueUserobject for masking/pinning grains and making forces and torques acting on that grain zero
  • RandomEulerAngleProviderAssign random Euler angles for each grain.
  • SolutionRasterizerProcess an XYZ file of atomic coordinates and filter atoms via threshold or map variable values.

Variables

Variables/CHPFCRFFSplitVariables

Variables/HHPFCRFFSplitVariables

Variables/PFCRFFVariables

Variables/PolycrystalVariables

VectorPostprocessors