DeformedGrainMaterial

under construction:Undocumented Class

The DeformedGrainMaterial has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# DeformedGrainMaterial

!syntax description /Materials/DeformedGrainMaterial

## Overview

!! Replace these lines with information regarding the DeformedGrainMaterial object.

## Example Input File Syntax

!! Describe and include an example of how to use the DeformedGrainMaterial object.

!syntax parameters /Materials/DeformedGrainMaterial

!syntax inputs /Materials/DeformedGrainMaterial

!syntax children /Materials/DeformedGrainMaterial

!syntax description /Materials/DeformedGrainMaterial

Input Parameters

deformed_grain_numNumber of OP representing deformed grains
C++ Type:unsigned int
Options:
Description:Number of OP representing deformed grains
grain_trackerThe GrainTracker UserObject to get values from.
C++ Type:UserObjectName
Options:
Description:The GrainTracker UserObject to get values from.
vArray of coupled variables
C++ Type:std::vector
Options:
Description:Array of coupled variables

Required Parameters

Burg_vec3e-10Length of Burger Vector in m
Default:3e-10
C++ Type:double
Options:
Description:Length of Burger Vector in m
Disloc_Den9e+15Dislocation Density in m^-2
Default:9e+15
C++ Type:double
Options:
Description:Dislocation Density in m^-2
Elas_Mod2.5e+10Elastic Modulus in J/m^3
Default:2.5e+10
C++ Type:double
Options:
Description:Elastic Modulus in J/m^3
GBE1Grain boundary energy in J/m^2
Default:1
C++ Type:double
Options:
Description:Grain boundary energy in J/m^2
GBMobility2e-13GB mobility input in m^4/(J*s)
Default:2e-13
C++ Type:double
Options:
Description:GB mobility input in m^4/(J*s)
blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Options:
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Options:NONE ELEMENT SUBDOMAIN
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
int_width4Diffuse Interface width in length_scale unit
Default:4
C++ Type:double
Options:
Description:Diffuse Interface width in length_scale unit
length_scale1e-09Length scale in m, where default is nm
Default:1e-09
C++ Type:double
Options:
Description:Length scale in m, where default is nm
op_numArray of coupled variables (num_name)
C++ Type:unsigned int
Options:
Description:Array of coupled variables (num_name)
time_scale1e-06Time scale in sec, where default is micro sec
Default:1e-06
C++ Type:double
Options:
Description:Time scale in sec, where default is micro sec
var_name_baseArray of coupled variables (base_name)
C++ Type:std::string
Options:
Description:Array of coupled variables (base_name)

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
Description:Determines whether this object is calculated using an implicit or explicit form
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Options:
Description:The seed for the master random number generator
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Options:
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector
Options:
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector
Options:
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files

modules/phase_field/test/tests/DeformedGrain/DeformedGrain.i

modules/phase_field/test/tests/DeformedGrain/DeformedGrain.i

# This example tests the implementation of PolycrstalStoredEnergy kernels that assigns excess stored energy to grains with dislocation density
[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 32
  ny = 32
  nz = 0
  xmin = 0
  xmax = 64
  ymin = 0
  ymax = 64
[]

[GlobalParams]
  block = 0
  op_num = 8
  deformed_grain_num = 16
  var_name_base = gr
  grain_num = 18
  grain_tracker = grain_tracker
  time_scale = 1e-2
  length_scale = 1e-8
[]

[Variables]
  [./PolycrystalVariables]
  [../]
[]

[AuxVariables]
  [./bnds]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[UserObjects]
  [./voronoi]
    type = PolycrystalVoronoi
    rand_seed = 81
    coloring_algorithm = bt
  [../]
  [./grain_tracker]
    type = GrainTracker
    threshold = 0.2
    connecting_threshold = 0.08
    compute_var_to_feature_map = true
    flood_entity_type = elemental
    execute_on = ' initial timestep_begin'
    outputs = none
  [../]
[]

[ICs]
  [./PolycrystalICs]
    [./PolycrystalColoringIC]
      polycrystal_ic_uo = voronoi
    [../]
  [../]
[]

[BCs]
  [./Periodic]
    [./all]
      auto_direction = 'x y'
    [../]
  [../]
[]

[Kernels]
  [./PolycrystalKernel]
  [../]
  [./PolycrystalStoredEnergy]
  [../]
[]

[AuxKernels]
  [./BndsCalc]
    type = BndsCalcAux
    variable = bnds
    execute_on = timestep_end
  [../]
[]

[Materials]
  [./deformed]
    type = DeformedGrainMaterial
    int_width = 4.0
    outputs = exodus
  [../]
[]

[Preconditioning]
  [./SMP]
    type = SMP
    full = true
  [../]
[]

[Executioner]
  type = Transient
  nl_max_its = 15
  scheme = bdf2
  solve_type = PJFNK
  petsc_options_iname = -pc_type
  petsc_options_value = asm
  l_max_its = 15
  l_tol = 1.0e-3
  nl_rel_tol = 1.0e-8
  start_time = 0.0
  num_steps = 1
  nl_abs_tol = 1e-8
  dt = 0.20
[]

[Outputs]
  exodus = true
  interval = 1
  show = bnds
  perf_graph = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools