ReconPhaseVarIC

under construction:Undocumented Class

The ReconPhaseVarIC 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.


# ReconPhaseVarIC

!syntax description /ICs/ReconPhaseVarIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/ReconPhaseVarIC

!syntax inputs /ICs/ReconPhaseVarIC

!syntax children /ICs/ReconPhaseVarIC

!syntax description /ICs/ReconPhaseVarIC

Input Parameters

ebsd_readerThe EBSDReader object holding the EBSD data
C++ Type:UserObjectName
Options:
Description:The EBSDReader object holding the EBSD data
phaseEBSD phase number this variable is to represent
C++ Type:unsigned int
Options:
Description:EBSD phase number this variable is to represent
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Options:
Description:The variable this initial condition is supposed to provide values for.

Required Parameters

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

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.
ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC
Default:False
C++ Type:bool
Options:
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters

Input Files

modules/phase_field/test/tests/reconstruction/euler2rgb_no_grain_region.i
modules/phase_field/test/tests/reconstruction/2phase_reconstruction.i

modules/phase_field/test/tests/reconstruction/euler2rgb_no_grain_region.i

[Mesh]
  type = EBSDMesh
  filename = ebsd_small.txt
[]

[GlobalParams]
  op_num = 8
  var_name_base = gr
[]

[UserObjects]
  [./ebsd_reader]
    type = EBSDReader
    execute_on = initial
  [../]
  [./ebsd]
    type = PolycrystalEBSD
    coloring_algorithm = bt
    ebsd_reader = ebsd_reader
    phase = 2
    output_adjacency_matrix = true
  [../]
  [./grain_tracker]
    type = GrainTracker
    polycrystal_ic_uo = ebsd
  [../]
[]

[ICs]
  [./PolycrystalICs]
    [./PolycrystalColoringIC]
      polycrystal_ic_uo = ebsd
    [../]
  [../]
  [./void_phase]
    type = ReconPhaseVarIC
    variable = c
    ebsd_reader = ebsd_reader
    phase = 1
  [../]
[]

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

[AuxVariables]
#  active = 'c bnds'

  [./c]
  [../]
  [./bnds]
  [../]
  [./ebsd_numbers]
    family = MONOMIAL
    order = CONSTANT
  [../]

  # Note: Not active
  [./unique_grains]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./var_indices]
    family = MONOMIAL
    order = CONSTANT
  [../]
[]

[Kernels]
  [./PolycrystalKernel]
    c = c
  [../]
[]

[AuxKernels]
#  active = 'BndsCalc'

  [./BndsCalc]
    type = BndsCalcAux
    variable = bnds
    execute_on = 'initial timestep_end'
  [../]
  [./ebsd_numbers]
    type = EBSDReaderAvgDataAux
    data_name = feature_id
    ebsd_reader = ebsd_reader
    grain_tracker = grain_tracker
    variable = ebsd_numbers
    phase = 2
    execute_on = 'initial timestep_end'
  [../]

  # Note: Not active
  [./unique_grains]
    type = FeatureFloodCountAux
    variable = unique_grains
    flood_counter = grain_tracker
    field_display = UNIQUE_REGION
    execute_on = 'initial timestep_end'
  [../]
  [./var_indices]
    type = FeatureFloodCountAux
    variable = var_indices
    flood_counter = grain_tracker
    field_display = VARIABLE_COLORING
    execute_on = 'initial timestep_end'
  [../]
[]

[Modules]
  [./PhaseField]
    [./EulerAngles2RGB]
      crystal_structure = cubic
      grain_tracker = grain_tracker
      euler_angle_provider = ebsd_reader
      no_grain_color = '.1 .1 .1'
      phase = 2
    [../]
  [../]
[]

[Materials]
  [./bulk]
    type = GBEvolution
    block = 0
    T = 2273
    wGB = 10.0
    GBenergy = 1.58
    GBmob0 = 9.2124e-9
    Q = 2.77
    length_scale = 1.0e-6
    time_scale = 60.0
  [../]
[]

[Executioner]
  type = Transient
  scheme = bdf2
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -sub_pc_type -pc_asm_overlap -ksp_grmres_restart '
  petsc_options_value = '   asm        lu            1               21'
  start_time = 0.0
  dt = 0.2
  num_steps = 1
[]

[Outputs]
  csv = true
  exodus = true
  execute_on = 'INITIAL TIMESTEP_END'
  perf_graph = true
[]

modules/phase_field/test/tests/reconstruction/2phase_reconstruction.i

#
# In this test we set the initial condition of two variables
# based on solely the phase information in a given EBSD data file,
# ignoring the feature IDs entirely
#

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

# The following sections are extracted in the documentation in
# moose/docs/content/modules/phase_field/ICs/EBSD.md

[Mesh]
  # Create a mesh representing the EBSD data
  type = EBSDMesh
  filename = 'Ti_2Phase_28x28_ebsd.txt'
[]

[UserObjects]
  [./ebsd]
    # Read in the EBSD data. Uses the filename given in the mesh block.
    type = EBSDReader
  [../]
[]

[Variables]
  # Creates the two variables being initialized
  [./c1]
  [../]
  [./c2]
  [../]
[]

[ICs]
  [./phase1_recon]
    # Initializes the variable info from the ebsd data
    type = ReconPhaseVarIC
    ebsd_reader = ebsd
    phase = 1
    variable = c1
  [../]
  [./phase2_recon]
    type = ReconPhaseVarIC
    ebsd_reader = ebsd
    phase = 2
    variable = c2
  [../]
[]
#ENDDOC - End of the file section that is included in the documentation. Do not change this line!

[AuxVariables]
  [./PHI1]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./PHI]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./APHI2]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./PHI2]
    family = MONOMIAL
    order = CONSTANT
  [../]
  [./PHASE]
    family = MONOMIAL
    order = CONSTANT
  [../]
[]

[AuxKernels]
  [./phi1_aux]
    type = EBSDReaderPointDataAux
    variable = PHI1
    ebsd_reader = ebsd
    data_name = 'phi1'
    execute_on = 'initial'
  [../]
  [./phi_aux]
    type = EBSDReaderPointDataAux
    variable = PHI
    ebsd_reader = ebsd
    data_name = 'phi'
    execute_on = 'initial'
  [../]
  [./phi2_aux]
    type = EBSDReaderPointDataAux
    variable = PHI2
    ebsd_reader = ebsd
    data_name = 'phi2'
    execute_on = 'initial'
  [../]
  [./phase_aux]
    type = EBSDReaderPointDataAux
    variable = PHASE
    ebsd_reader = ebsd
    data_name = 'phase'
    execute_on = 'initial'
  [../]
[]

[Executioner]
  type = Transient
  num_steps = 0
[]

[Outputs]
  exodus = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools