FEHM.avs2jldMethod

Methods:

  • FEHM.avs2jld(geofilename, rootname, jldfilename; timefilter, suffix) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:383

Arguments:

  • geofilename : geo file name
  • jldfilename : jld file name
  • rootname : root name of .avs_log file

Keywords:

  • suffix
  • timefilter : function which defines whether the data of a specific time is going to be used [default=true]

Dumps:

  • jld file
FEHM.avs2jld2Method

Methods:

  • FEHM.avs2jld2(geofilename, rootname, jld2filename; timefilter) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:419

Arguments:

  • geofilename : geo file name
  • jld2filename : jld file name
  • rootname : root name of .avs_log file

Keywords:

  • timefilter : function which defines whether the data of a specific time is going to be used [default=true]

Dumps:

  • jld2 file
FEHM.avs2vtkMethod

Methods:

  • FEHM.avs2vtk(geofilename, rootname, pvdrootname, vtkrootname) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:344

Arguments:

  • geofilename : geo file name
  • pvdrootname : pvd file root name
  • rootname : root name of .avs_log file
  • vtkrootname : vtk file root name

Dumps:

  • vtk file
FEHM.dumpzoneMethod

Write zone information into a file

Methods:

  • FEHM.dumpzone(filename::String, zonenumbers::Array{T,1} where T, nodenumbers::Array{T,1} where T; keyword) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:179

Arguments:

  • filename::String : output file name
  • nodenumbers::Array{T,1} where T : node numbers
  • zonenumbers::Array{T,1} where T : zone numbers

Keywords:

  • keyword : [default="zonn"]

Dumps:

  • a file contain zone information named by the value of 'filename'
FEHM.fehmday2yearMethod

Convert FEHM day into a year (default start year is 1964)

Methods:

  • FEHM.fehmday2year(fehmday; offset) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:74

Arguments:

  • fehmday : the FEHM day to convert

Keywords:

  • offset : the start year [default=1964]

Returns:

  • the converted year
FEHM.flattenzonesMethod

Flatten zones

Methods:

  • FEHM.flattenzones(zonenumbers, nodenumbers, isanode, zoneornodenums, otherstuff...) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:615

Arguments:

  • isanode : whether this is a node
  • nodenumbers : node numbers
  • zonenumbers : zone numbers
  • zoneornodenums : zone or node numbers

Returns:

  • node numbers
  • other stuff
FEHM.getwellnodesFunction

Get nodes of wells from the input file

Methods:

  • FEHM.getwellnodes(filename::String, x::Number, y::Number; kw...) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:134
  • FEHM.getwellnodes(c::Array, x::Number, y::Number; topnodes, nodespercolumn) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:138

Arguments:

  • c::Array : file handle
  • filename::String : input file name
  • x::Number : x coordinates
  • y::Number : y coordinates

Keywords:

  • nodespercolumn : nodes per column [default=44]
  • topnodes : top nodes [default=2]

Example:

FEHM.getwellnodes("tet.xyz", (499950.3031-100), 539101.3053)
FEHM.parsefinMethod

Parse the input file

Methods:

  • FEHM.parsefin(filename) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:88

Arguments:

  • filename : file name

Returns:

  • a dictionary of parsed file
FEHM.parseflowFunction

Methods:

  • FEHM.parseflow(filename::String) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:510
  • FEHM.parseflow(lines::Array{T,1} where T, filename) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:513

Arguments:

  • filename : input file name
  • filename::String : input file name
  • lines::Array{T,1} where T : a vector of the input file with each line an element

Returns:

  • isanode : whether this is a node
  • zoneornodenums : zone or node numbers
  • skds :
  • eflows :
  • aipeds :
FEHM.parsegeoFunction

Parse geo file

Methods:

  • FEHM.parsegeo(geofilename) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:296
  • FEHM.parsegeo(geofilename, docells) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:296

Arguments:

  • docells : whether to get cell information [default=true]
  • geofilename : geo file name

Returns:

  • x, y, z coordinates and mesh cell information
FEHM.parsegridMethod

Parse the grid coordinates from the input FEHM file

Methods:

  • FEHM.parsegrid(fehmfilename) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:268

Arguments:

  • fehmfilename : FEHM file name

Returns:

  • coordinates of the grid
FEHM.parsehycoFunction

Methods:

  • FEHM.parsehyco(filename::String) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:555
  • FEHM.parsehyco(lines::Array{T,1} where T, filename::String) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:558

Arguments:

  • filename::String : input file name
  • lines::Array{T,1} where T : a vector of the input file with each line an element

Returns:

  • isanode : whether this is a node
  • zoneornodenums : zone or node numbers
  • kxs :
  • kys :
  • kzs :
FEHM.parsestorMethod

Methods:

  • FEHM.parsestor(filename) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:467

Arguments:

  • filename : input file name

Returns:

  • volumes :
  • areasoverlengths : areas over lengths
  • connections :
FEHM.parsezoneFunction

Parse zone information from input file

Methods:

  • FEHM.parsezone(filename::String; returndict) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:196
  • FEHM.parsezone(lines::Array{T,1} where T; returndict) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:200

Arguments:

  • filename::String : input file name
  • lines::Array{T,1} where T : a vector of the input file with each line an element

Keywords:

  • returndict : whether to return the zone information in dictoinaries [default=false]

Returns:

  • zone numbers and node numbers
FEHM.testMethod

Run the tests in runtests.jl

Methods:

  • FEHM.test() in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:22
FEHM.writefinMethod

Write data into a file

Methods:

  • FEHM.writefin(findata, filename; writekeys) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:119

Arguments:

  • filename : file name
  • findata : input data to write

Keywords:

  • writekeys : the keys of the items that will be written into the file [default=["saturation", "pressure", "no fluxes"]]

Dumps:

  • a file with input data written in it and named by the value of 'filename'
FEHM.year2fehmdayMethod

Convert a year into FEHM day (default start year is 1964)

Methods:

  • FEHM.year2fehmday(year; offset) in FEHM : /juliateam/.julia/packages/FEHM/EvaCA/src/FEHM.jl:59

Arguments:

  • year : the year to convert

Keywords:

  • offset : the start year [default=1964]

Returns:

  • FEHM day