{
  "category": "wall",
  "search_keywords": [
    "history",
    "track",
    "monitor"
  ],
  "description": "Adds a history of a wall value. A history is a table of floating point values assigned by sampling a model attribute periodically during a simulation. The history can be assigned a name for later reference with the optional name keyword, if not the history will be given a default name based on its internally assigned id number. Following one of the keywords given below, either 1) an additional 'id' keyword followed by an integer id, 2) an additional 'name' keyword followed by a string s, or 3) an additional 'position' keyword followed by a position vector v must be given to define the specific wall.",
  "python_sdk_alternative": {
    "available": false,
    "workaround": "itasca.command('wall history ...') - Python SDK does not provide history recording. Use history commands for manipulation"
  },
  "versions": {
    "7.0": {
      "command": "wall history",
      "syntax": "wall history [name <sid>] keyword ...",
      "keywords": [
        {
          "name": "displacement",
          "syntax": "displacement",
          "description": "Magnitude of the accumulated wall displacement vector as a result of cycling."
        },
        {
          "name": "displacement-x",
          "syntax": "displacement-x",
          "description": "The \\(x\\) -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "displacement-y",
          "syntax": "displacement-y",
          "description": "The \\(y\\) -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "displacement-z",
          "syntax": "displacement-z",
          "description": "The \\(z\\) -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "euler-x",
          "syntax": "euler-x",
          "description": "The \\(x\\) -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "euler-y",
          "syntax": "euler-y",
          "description": "The \\(y\\) -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "euler-z",
          "syntax": "euler-z",
          "description": "The \\(z\\) -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "extra",
          "syntax": "extra",
          "description": "Take a history of an extra variable. Use index to specify the extra index and type to specify the type."
        },
        {
          "name": "force-contact",
          "syntax": "force-contact",
          "description": "The magnitude of the force resulting from contacts."
        },
        {
          "name": "force-contact-x",
          "syntax": "force-contact-x",
          "description": "The \\(x\\) -component of the contact force."
        },
        {
          "name": "force-contact-y",
          "syntax": "force-contact-y",
          "description": "The \\(y\\) -component of the contact force."
        },
        {
          "name": "force-contact-z",
          "syntax": "force-contact-z",
          "description": "The \\(z\\) -component of the contact force."
        },
        {
          "name": "moment-contact",
          "syntax": "moment-contact",
          "description": "{Value in 2D; Magnitude in 3D} of the sum of the contact moments."
        },
        {
          "name": "moment-contact-x",
          "syntax": "moment-contact-x",
          "description": "The \\(x\\) -component of the contact moment."
        },
        {
          "name": "moment-contact-y",
          "syntax": "moment-contact-y",
          "description": "The \\(y\\) -component of the contact moment."
        },
        {
          "name": "moment-contact-z",
          "syntax": "moment-contact-z",
          "description": "The \\(z\\) -component of the contact moment."
        },
        {
          "name": "position-x",
          "syntax": "position-x",
          "description": "The \\(x\\) -component of the location of wall centroid."
        },
        {
          "name": "position-y",
          "syntax": "position-y",
          "description": "The \\(y\\) -component of the location of wall centroid."
        },
        {
          "name": "position-z",
          "syntax": "position-z",
          "description": "The \\(z\\) -component of the location of wall centroid."
        },
        {
          "name": "rotation",
          "syntax": "rotation",
          "description": "Current wall orientation. The orientation is updated only when orientation tracking has been enabled (see model orientation-tracking command)."
        },
        {
          "name": "spin",
          "syntax": "spin",
          "description": "{Value in 2D; Magnitude in 3D} of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-x",
          "syntax": "spin-x",
          "description": "The \\(x\\) -component of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-y",
          "syntax": "spin-y",
          "description": "The \\(y\\) -component of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-z",
          "syntax": "spin-z",
          "description": "The \\(z\\) -component of the wall angular velocity in radians per second."
        },
        {
          "name": "velocity",
          "syntax": "velocity",
          "description": "Magnitude of the wall translational velocity vector."
        },
        {
          "name": "velocity-x",
          "syntax": "velocity-x",
          "description": "The \\(x\\) -component of the wall velocity."
        },
        {
          "name": "velocity-y",
          "syntax": "velocity-y",
          "description": "The \\(y\\) -component of the wall velocity."
        },
        {
          "name": "velocity-z",
          "syntax": "velocity-z",
          "description": "The \\(z\\) -component of the wall velocity."
        },
        {
          "name": "magnitude",
          "syntax": "magnitude",
          "description": "This keyword selects which scalar to retrieve from a vector type value, such as velocity or displacement. If the value type is not a vector, this setting is ignored. The available options are:"
        },
        {
          "name": "kwd:id",
          "syntax": "id <i>",
          "description": "Record the history of wall with ID i ."
        },
        {
          "name": "kwd:index",
          "syntax": "index <i>",
          "description": "For keywords that require it (most notably extra ), this specifies the index that should be used."
        },
        {
          "name": "kwd:log",
          "syntax": "log <b>",
          "description": "If on , the returned number is the base 10 log of the absolute value of the original value. The default is off ."
        },
        {
          "name": "kwd:name",
          "syntax": "name <s>",
          "description": "Record the history of wall with name s ."
        },
        {
          "name": "kwd:position",
          "syntax": "position <v>",
          "description": "Record the history of wall either containing or closest to position v ."
        },
        {
          "name": "zz",
          "syntax": "zz",
          "description": "This keyword selects which scalar to retrieve from a symmetric tensor type value, such as stress or strain. If the value type is not a tensor, this setting is ignored. The available options are: Record the intermediate principal value of the tensor. Record the maximum (most positive) principal value of the tensor. Note that compressive stresses are negative . Record the mean value, defined as the trace of the tensor divided by { 2 in 2D; 3 in 3D}. For stresses this is most often referred to as the pressure. Record the minimum (most negative) principal value of the tensor. Note that compressive stresses are negative . Record the norm of the full tensor. This is defined as the sum of each tensor component squared. Record the octahedral measure of the tensor. Record the maximum shear value. Record the distance of the tensor value to the origin in principal space. Record the volumetric change, or trace of the tensor. Record the Von Mises measure. Record the xx -component of the tensor. Record the xy -component of the tensor. Record the xz -component of the tensor. Record the yy -component of the tensor. Record the yz -component of the tensor. Record the zz -component of the tensor."
        },
        {
          "name": "vector",
          "syntax": "vector",
          "description": "In certain cases the type (scalar, vector, or tensor) of the value cannot necessarily be determined ahead of time. Extra variables, for example, can hold values of all three types. This keyword allows one to specify which type it is assumed to be. If the original value type does not match, 0.0 is returned. Specify a scalar float type. Specify a tensor type. Specify a vector type."
        }
      ],
      "examples": [
        {
          "command": "wall history name 'wall1_force' force-contact id 1",
          "description": "Track contact force magnitude for wall ID 1, name history 'wall1_force'"
        },
        {
          "command": "wall history displacement-z name 'platen'",
          "description": "Track z-displacement for wall named 'platen' (3D)"
        },
        {
          "command": "wall history velocity-x position (0,0,5)",
          "description": "Track x-velocity for wall nearest to position (0,0,5)"
        },
        {
          "command": "wall history name 'bottom_vel' velocity-z id 100",
          "description": "Track z-velocity for wall ID 100, name history 'bottom_vel'"
        },
        {
          "command": "wall history force-contact-x name 'boundary'",
          "description": "Track x-component of contact force for wall named 'boundary'"
        },
        {
          "command": "wall history spin-z id 5",
          "description": "Track z-component of angular velocity for wall ID 5 (3D)"
        },
        {
          "command": "wall history extra index 1 type float id 10",
          "description": "Track extra variable at index 1 (float type) for wall ID 10"
        }
      ]
    },
    "6.0": {
      "command": "wall history",
      "syntax": "wall history [name <sid>] keyword id <id>or name <s>or position <v>",
      "keywords": [
        {
          "name": "displacement",
          "syntax": "displacement",
          "description": "Magnitude of the accumulated wall displacement vector as a result of cycling."
        },
        {
          "name": "displacement-x",
          "syntax": "displacement-x",
          "description": "The x -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "displacement-y",
          "syntax": "displacement-y",
          "description": "The y -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "displacement-z",
          "syntax": "displacement-z",
          "description": "The z -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "euler-x",
          "syntax": "euler-x",
          "description": "The x -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "euler-y",
          "syntax": "euler-y",
          "description": "The y -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "euler-z",
          "syntax": "euler-z",
          "description": "The z -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "force-contact",
          "syntax": "force-contact",
          "description": "The magnitude of the force resulting from contacts."
        },
        {
          "name": "force-contact-x",
          "syntax": "force-contact-x",
          "description": "The x -component of the contact force."
        },
        {
          "name": "force-contact-y",
          "syntax": "force-contact-y",
          "description": "The y -component of the contact force."
        },
        {
          "name": "force-contact-z",
          "syntax": "force-contact-z",
          "description": "The z -component of the contact force."
        },
        {
          "name": "moment-contact",
          "syntax": "moment-contact",
          "description": "{Value in 2D; Magnitude in 3D} of the sum of the contact moments."
        },
        {
          "name": "moment-contact-x",
          "syntax": "moment-contact-x",
          "description": "The x -component of the contact moment."
        },
        {
          "name": "moment-contact-y",
          "syntax": "moment-contact-y",
          "description": "The y -component of the contact moment."
        },
        {
          "name": "moment-contact-z",
          "syntax": "moment-contact-z",
          "description": "The z -component of the contact moment."
        },
        {
          "name": "position-x",
          "syntax": "position-x",
          "description": "The x -component of the location of wall centroid."
        },
        {
          "name": "position-y",
          "syntax": "position-y",
          "description": "The y -component of the location of wall centroid."
        },
        {
          "name": "position-z",
          "syntax": "position-z",
          "description": "The z -component of the location of wall centroid."
        },
        {
          "name": "rotation",
          "syntax": "rotation",
          "description": "Current wall orientation. The orientation is updated only when orientation tracking has been enabled (see model orientation-tracking command)."
        },
        {
          "name": "spin",
          "syntax": "spin",
          "description": "{Value in 2D; Magnitude in 3D} of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-x",
          "syntax": "spin-x",
          "description": "The x -component of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-y",
          "syntax": "spin-y",
          "description": "The y -component of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-z",
          "syntax": "spin-z",
          "description": "The z -component of the wall angular velocity in radians per second."
        },
        {
          "name": "velocity",
          "syntax": "velocity",
          "description": "Magnitude of the wall translational velocity vector."
        },
        {
          "name": "velocity-x",
          "syntax": "velocity-x",
          "description": "The x -component of the wall velocity."
        },
        {
          "name": "velocity-y",
          "syntax": "velocity-y",
          "description": "The y -component of the wall velocity."
        },
        {
          "name": "velocity-z",
          "syntax": "velocity-z",
          "description": "The z -component of the wall velocity."
        }
      ],
      "examples": [
        {
          "command": "wall history name 'wall1_force' force-contact id 1",
          "description": "Track contact force magnitude for wall ID 1, name history 'wall1_force'"
        },
        {
          "command": "wall history displacement-z name 'platen'",
          "description": "Track z-displacement for wall named 'platen' (3D)"
        },
        {
          "command": "wall history velocity-x position (0,0,5)",
          "description": "Track x-velocity for wall nearest to position (0,0,5)"
        },
        {
          "command": "wall history name 'bottom_vel' velocity-z id 100",
          "description": "Track z-velocity for wall ID 100, name history 'bottom_vel'"
        },
        {
          "command": "wall history force-contact-x name 'boundary'",
          "description": "Track x-component of contact force for wall named 'boundary'"
        },
        {
          "command": "wall history spin-z id 5",
          "description": "Track z-component of angular velocity for wall ID 5 (3D)"
        },
        {
          "command": "wall history extra index 1 type float id 10",
          "description": "Track extra variable at index 1 (float type) for wall ID 10"
        }
      ]
    },
    "9.0": {
      "command": "wall history",
      "syntax": "wall history [name <sid>] keyword ...",
      "keywords": [
        {
          "name": "displacement",
          "syntax": "displacement [wallhistoryblock]",
          "description": "Magnitude of the accumulated wall displacement vector as a result of cycling."
        },
        {
          "name": "displacement-x",
          "syntax": "displacement-x [wallhistoryblock]",
          "description": "The \\(x\\) -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "displacement-y",
          "syntax": "displacement-y [wallhistoryblock]",
          "description": "The \\(y\\) -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "displacement-z",
          "syntax": "displacement-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -component of accumulated displacement as a result of cycling."
        },
        {
          "name": "euler-x",
          "syntax": "euler-x 3D ONLY [wallhistoryblock]",
          "description": "The \\(x\\) -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "euler-y",
          "syntax": "euler-y 3D ONLY [wallhistoryblock]",
          "description": "The \\(y\\) -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "euler-z",
          "syntax": "euler-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -euler angle (in degrees) of the current wall orientation. The orientation is updated only when orientation tracking has been enabled (see the model orientation-tracking command). See the euler keyword of the wall attribute command."
        },
        {
          "name": "extra",
          "syntax": "extra [wallhistoryblock]",
          "description": "Take a history of an extra variable. Use index to specify the extra index and type to specify the type."
        },
        {
          "name": "force-contact",
          "syntax": "force-contact [wallhistoryblock]",
          "description": "The magnitude of the force resulting from contacts."
        },
        {
          "name": "force-contact-x",
          "syntax": "force-contact-x [wallhistoryblock]",
          "description": "The \\(x\\) -component of the contact force."
        },
        {
          "name": "force-contact-y",
          "syntax": "force-contact-y [wallhistoryblock]",
          "description": "The \\(y\\) -component of the contact force."
        },
        {
          "name": "force-contact-z",
          "syntax": "force-contact-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -component of the contact force."
        },
        {
          "name": "moment-contact",
          "syntax": "moment-contact [wallhistoryblock]",
          "description": "{Value in 2D; Magnitude in 3D} of the sum of the contact moments."
        },
        {
          "name": "moment-contact-x",
          "syntax": "moment-contact-x 3D ONLY [wallhistoryblock]",
          "description": "The \\(x\\) -component of the contact moment."
        },
        {
          "name": "moment-contact-y",
          "syntax": "moment-contact-y 3D ONLY [wallhistoryblock]",
          "description": "The \\(y\\) -component of the contact moment."
        },
        {
          "name": "moment-contact-z",
          "syntax": "moment-contact-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -component of the contact moment."
        },
        {
          "name": "position-x",
          "syntax": "position-x [wallhistoryblock]",
          "description": "The \\(x\\) -component of the location of wall centroid."
        },
        {
          "name": "position-y",
          "syntax": "position-y [wallhistoryblock]",
          "description": "The \\(y\\) -component of the location of wall centroid."
        },
        {
          "name": "position-z",
          "syntax": "position-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -component of the location of wall centroid."
        },
        {
          "name": "rotation",
          "syntax": "rotation 2D ONLY [wallhistoryblock]",
          "description": "Current wall orientation. The orientation is updated only when orientation tracking has been enabled (see model orientation-tracking command)."
        },
        {
          "name": "spin",
          "syntax": "spin [wallhistoryblock]",
          "description": "{Value in 2D; Magnitude in 3D} of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-x",
          "syntax": "spin-x 3D ONLY [wallhistoryblock]",
          "description": "The \\(x\\) -component of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-y",
          "syntax": "spin-y 3D ONLY [wallhistoryblock]",
          "description": "The \\(y\\) -component of the wall angular velocity in radians per second."
        },
        {
          "name": "spin-z",
          "syntax": "spin-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -component of the wall angular velocity in radians per second."
        },
        {
          "name": "velocity",
          "syntax": "velocity [wallhistoryblock]",
          "description": "Magnitude of the wall translational velocity vector."
        },
        {
          "name": "velocity-x",
          "syntax": "velocity-x [wallhistoryblock]",
          "description": "The \\(x\\) -component of the wall velocity."
        },
        {
          "name": "velocity-y",
          "syntax": "velocity-y [wallhistoryblock]",
          "description": "The \\(y\\) -component of the wall velocity."
        },
        {
          "name": "velocity-z",
          "syntax": "velocity-z 3D ONLY [wallhistoryblock]",
          "description": "The \\(z\\) -component of the wall velocity."
        },
        {
          "name": "magnitude",
          "syntax": "magnitude",
          "description": "This keyword selects which scalar to retrieve from a vector type value, such as velocity or displacement. If the value type is not a vector, this setting is ignored. The available options are: Record the \\(x\\) -component of the vector. Record the \\(y\\) -component of the vector. Record the \\(z\\) -component of the vector. Record the vector magnitude."
        },
        {
          "name": "kwd:id",
          "syntax": "id <i>",
          "description": "Record the history of wall with ID i ."
        },
        {
          "name": "kwd:index",
          "syntax": "index <i>",
          "description": "For keywords that require it (most notably extra ), this specifies the index that should be used."
        },
        {
          "name": "kwd:log",
          "syntax": "log <b>",
          "description": "If on , the returned number is the base 10 log of the absolute value of the original value. The default is off ."
        },
        {
          "name": "kwd:name",
          "syntax": "name <s>",
          "description": "Record the history of wall with name s ."
        },
        {
          "name": "kwd:position",
          "syntax": "position <v>",
          "description": "Record the history of wall either containing or closest to position v ."
        },
        {
          "name": "zz",
          "syntax": "zz 3D ONLY",
          "description": "This keyword selects which scalar to retrieve from a symmetric tensor type value, such as stress or strain. If the value type is not a tensor, this setting is ignored. The available options are: Record the intermediate principal value of the tensor. Record the maximum (most positive) principal value of the tensor. Note that compressive stresses are negative . Record the mean value, defined as the trace of the tensor divided by { 2 in 2D; 3 in 3D}. For stresses this is most often referred to as the pressure. Record the minimum (most negative) principal value of the tensor. Note that compressive stresses are negative . Record the norm of the full tensor. This is defined as the sum of each tensor component squared. Record the octahedral measure of the tensor. Record the maximum shear value. Record the distance of the tensor value to the origin in principal space. Record the volumetric change, or trace of the tensor. Record the Von Mises measure. Record the xx -component of the tensor. Record the xy -component of the tensor. Record the xz -component of the tensor. Record the yy -component of the tensor. Record the yz -component of the tensor. Record the zz -component of the tensor."
        },
        {
          "name": "vector",
          "syntax": "vector",
          "description": "In certain cases the type (scalar, vector, or tensor) of the value cannot necessarily be determined ahead of time. Extra variables, for example, can hold values of all three types. This keyword allows one to specify which type it is assumed to be. If the original value type does not match, 0.0 is returned. Specify a scalar float type. Specify a tensor type. Specify a vector type."
        }
      ],
      "examples": [
        {
          "command": "wall history name 'wall1_force' force-contact id 1",
          "description": "Track contact force magnitude for wall ID 1, name history 'wall1_force'"
        },
        {
          "command": "wall history displacement-z name 'platen'",
          "description": "Track z-displacement for wall named 'platen' (3D)"
        },
        {
          "command": "wall history velocity-x position (0,0,5)",
          "description": "Track x-velocity for wall nearest to position (0,0,5)"
        },
        {
          "command": "wall history name 'bottom_vel' velocity-z id 100",
          "description": "Track z-velocity for wall ID 100, name history 'bottom_vel'"
        },
        {
          "command": "wall history force-contact-x name 'boundary'",
          "description": "Track x-component of contact force for wall named 'boundary'"
        },
        {
          "command": "wall history spin-z id 5",
          "description": "Track z-component of angular velocity for wall ID 5 (3D)"
        },
        {
          "command": "wall history extra index 1 type float id 10",
          "description": "Track extra variable at index 1 (float type) for wall ID 10"
        }
      ]
    }
  }
}
