BimodalSuperellipsoidsIC

under construction:Undocumented Class

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


# BimodalSuperellipsoidsIC

!syntax description /ICs/BimodalSuperellipsoidsIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/BimodalSuperellipsoidsIC

!syntax inputs /ICs/BimodalSuperellipsoidsIC

!syntax children /ICs/BimodalSuperellipsoidsIC

Bimodal size distribution of large particles (specified in input file) and small particles (placed randomly outside the larger particles)

Input Parameters

asSemiaxis a for each superellipsoid
C++ Type:std::vector
Options:
Description:Semiaxis a for each superellipsoid
bsSemiaxis b for each superellipsoid
C++ Type:std::vector
Options:
Description:Semiaxis b for each superellipsoid
csSemiaxis c for each superellipsoid
C++ Type:std::vector
Options:
Description:Semiaxis c for each superellipsoid
invalueThe variable value inside the superellipsoid
C++ Type:double
Options:
Description:The variable value inside the superellipsoid
large_spacminimum spacing between large and small particles, measured from closest edge to closest edge
C++ Type:double
Options:
Description:minimum spacing between large and small particles, measured from closest edge to closest edge
npartThe number of random (small) particles to place
C++ Type:unsigned int
Options:
Description:The number of random (small) particles to place
nsExponent n for each superellipsoid
C++ Type:std::vector
Options:
Description:Exponent n for each superellipsoid
outvalueThe variable value outside the superellipsoid
C++ Type:double
Options:
Description:The variable value outside the superellipsoid
small_aMean semiaxis a value for the randomly placed (small) superellipsoids
C++ Type:double
Options:
Description:Mean semiaxis a value for the randomly placed (small) superellipsoids
small_bMean semiaxis b value for the randomly placed (small) superellipsoids
C++ Type:double
Options:
Description:Mean semiaxis b value for the randomly placed (small) superellipsoids
small_cMean semiaxis c value for the randomly placed (small) superellipsoids
C++ Type:double
Options:
Description:Mean semiaxis c value for the randomly placed (small) superellipsoids
small_nExponent n for the randomly placed (small) superellipsoids
C++ Type:double
Options:
Description:Exponent n for the randomly placed (small) superellipsoids
small_spacminimum spacing between small particles, measured from closest edge to closest edge
C++ Type:double
Options:
Description:minimum spacing between small particles, measured from closest edge to closest edge
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.
x_positionsThe x-coordinate for each superellipsoid center
C++ Type:std::vector
Options:
Description:The x-coordinate for each superellipsoid center
y_positionsThe y-coordinate for each superellipsoid center
C++ Type:std::vector
Options:
Description:The y-coordinate for each superellipsoid center
z_positionsThe z-coordinate for each superellipsoid center
C++ Type:std::vector
Options:
Description:The z-coordinate for each superellipsoid center

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
int_width0The interfacial width of the void surface. Defaults to sharp interface
Default:0
C++ Type:double
Options:
Description:The interfacial width of the void surface. Defaults to sharp interface
nestedvalueThe variable value for nested particles inside the superellipsoid in inverse configuration
C++ Type:double
Options:
Description:The variable value for nested particles inside the superellipsoid in inverse configuration
numtries1000The number of tries to place the random particles
Default:1000
C++ Type:unsigned int
Options:
Description:The number of tries to place the random particles
rand_seed12345Seed value for the random number generator
Default:12345
C++ Type:unsigned int
Options:
Description:Seed value for the random number generator
size_variation0Plus or minus fraction of random variation in the semiaxes for uniform, standard deviation for normal
Default:0
C++ Type:double
Options:
Description:Plus or minus fraction of random variation in the semiaxes for uniform, standard deviation for normal
size_variation_typenoneType of distribution that random semiaxes will follow
Default:none
C++ Type:MooseEnum
Options:uniform normal none
Description:Type of distribution that random semiaxes will follow
zero_gradientFalseSet the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions.
Default:False
C++ Type:bool
Options:
Description:Set the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions.

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/initial_conditions/BimodalSuperellipsoidsIC.i

modules/phase_field/test/tests/initial_conditions/BimodalSuperellipsoidsIC.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 25
  ny = 25
  xmax = 50
  ymax = 50
  elem_type = QUAD4
[]

[Variables]
  [./c]
    order = THIRD
    family = HERMITE
  [../]
[]

[ICs]
  [./c]
    type = BimodalSuperellipsoidsIC
    variable = c
    x_positions = '10.0 40.0'
    y_positions = '25.0 25.0'
    z_positions = '0.0  0.0'
    as = '8.0 8.0'
    bs = '8.0 8.0'
    cs = '1 1'
    ns = '3.5 3.5'
    npart = 5
    invalue = 1.0
    outvalue = -0.8
    int_width = 4.0
    large_spac = 5
    small_spac = 2
    small_a = 5
    small_b = 5
    small_c = 5
    small_n = 2
    size_variation_type = normal
    size_variation = 0.5
  [../]
[]

[Kernels]
  [./ie_c]
    type = TimeDerivative
    variable = c
  [../]
  [./CHSolid]
    type = CHMath
    variable = c
    mob_name = M
  [../]
  [./CHInterface]
    type = CHInterface
    variable = c
    kappa_name = kappa_c
    mob_name = M
  [../]
[]

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

[Materials]
  [./constant]
    type = GenericConstantMaterial
    prop_names  = 'M kappa_c'
    prop_values = '1.0 1.0'
  [../]
[]

[Executioner]
  type = Transient
  scheme = 'bdf2'
  solve_type = 'NEWTON'

  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart'
  petsc_options_value = 'hypre boomeramg 31'

  l_max_its = 20
  l_tol = 1.0e-4
  nl_max_its = 40
  nl_rel_tol = 1e-9

  start_time = 0.0
  num_steps = 1
  dt = 2.0
[]

[Outputs]
  exodus = false
  [./out]
    type = Exodus
    refinements = 2
  [../]
[]

Child Objects

modules/phase_field/include/ics/BimodalInverseSuperellipsoidsIC.h

modules/phase_field/include/ics/BimodalInverseSuperellipsoidsIC.h

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "BimodalSuperellipsoidsIC.h"

// Forward Declarations
class BimodalInverseSuperellipsoidsIC;

template <>
InputParameters validParams<BimodalInverseSuperellipsoidsIC>();

/**
 * BimodalInverseSuperellipsoidsIC takes a specified number of superellipsoids, each with given
 *parameters
 * These are intended to be the larger particles. Then the IC creates a specified number
 * of particles at random locations. These are the smaller particles. Unlike in the parent class,
 *the smaller
 * particles are embedded inside the larger particles, which is why this IC is referred to as
 *Inverse.
 **/
class BimodalInverseSuperellipsoidsIC : public BimodalSuperellipsoidsIC
{
public:
  BimodalInverseSuperellipsoidsIC(const InputParameters & parameters);

  /// Have to do things slightly different from SmoothSuperellipsoidBaseIC because of the inverse structure
  virtual Real value(const Point & p);

  virtual void initialSetup();
  virtual void computeSuperellipsoidCenters();
};

Input Parameters
Input Files
Child Objects

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools