new commit

docs/api/JuliaFEM.abaqus_reader.rst

@@ -0,0 +1,12 @@
+JuliaFEM.abaqus_reader
+======================
+
+Internal
+--------
+
+ .. function:: add_handler(section,  function_name)
+
+source:
+-------
+[JuliaFEM/src/abaqus_reader.jl:18](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/abaqus_reader.jl#L18)
+

docs/api/JuliaFEM.elasticity_solver.rst

@@ -0,0 +1,93 @@
+JuliaFEM.elasticity_solver
+==========================
+
+Internal
+--------
+
+ .. function:: assemble!(fe,  eldofs_,  I,  V)
+
+    Assemble global RHS to I,V ready for sparse format
+
+    :param fe :  local vector
+    :param eldofs_ :  Array
+    :param I,V :  Arrays for sparse matrix
+    :notes: eldofs can also be node ids for convenience. In that case dimension
+            is calculated and eldofs are "extended" to problem dimension.
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:171](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L171)
+
+ .. function:: assemble!(ke,  eldofs_,  I,  J,  V)
+
+    Assemble global stiffness matrix to I,J,V ready for sparse format
+
+    :param ke :  local matrix
+    :param eldofs_ :  Array
+    :param I,J,V :  Arrays for sparse matrix
+    :notes: eldofs can also be node ids for convenience. In that case dimension
+            is calculated and eldofs are "extended" to problem dimension.
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:130](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L130)
+
+ .. function:: calc_local_matrices!(X,  u,  R,  Kt,  N,  dNdchi,  lambda_,  mu_,  ipoints,  iweights)
+
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:68](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L68)
+
+ .. function:: eliminate_boundary_conditions(dirichletbc,  I,  J,  V)
+
+    Eliminate Dirichlet boundary conditions from matrix
+
+    :param dirichletbc :  array [dim x nnodes]
+    :param I, J, V :  sparse matrix arrays
+    :returns: I, J, V : boundary conditions removed
+    :notes: pros:
+            - matrix assembly remains positive definite
+            cons:
+            - maybe inefficient because of extra sparse matrix operations. (It's hard to remove stuff from sparse matrix.)
+            - if u != 0 in dirichlet boundary requires extra care
+    :raises: Exception, if displacement boundary conditions given, i.e.
+             DX=2 for some node, for example.
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:218](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L218)
+
+ .. function:: eliminate_boundary_conditions(dirichletbc,  I,  V)
+
+    Eliminate Dirichlet boundary conditions from vector
+
+    :param dirichletbc :  array [dim x nnodes]
+    :param I, V :  sparse vector arrays
+    :returns: I, V : boundary conditions removed
+    :notes: pros:
+            - matrix assembly remains positive definite
+            cons:
+            - maybe inefficient because of extra sparse matrix operations. (It's hard to remove stuff from sparse matrix.)
+            - if u != 0 in dirichlet boundary requires extra care
+    :raises: Exception, if displacement boundary conditions given, i.e.
+             DX=2 for some node, for example.
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:257](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L257)
+
+ .. function:: interpolate{T<:Real}(field::Array{T<:Real, 1},  basis::Function,  ip)
+
+    Interpolate field variable using basis functions f for point ip.
+    This function tries to be as general as possible and allows interpolating
+    lot of different fields.
+
+    :param field :  Array{Number, dim}
+    :param basis :  Function
+    :param ip :  Array{Number, 1}
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:30](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L30)
+
+ .. function:: solve_elasticity_increment!(X,  u,  du,  elmap,  nodalloads,  dirichletbc,  lambda,  mu,  N,  dNdchi,  ipoints,  iweights)
+
+source:
+-------
+[JuliaFEM/src/elasticity_solver.jl:278](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/elasticity_solver.jl#L278)
+

docs/api/JuliaFEM.interfaces.rst

@@ -0,0 +1,16 @@
+JuliaFEM.interfaces
+===================
+
+Exported
+--------
+
+ .. function:: solve_elasticity_interface!()
+
+    This is generic interface that reads data from data model, solves elasticity
+    problem and updates model.
+
+    :param model :  to be defined
+source:
+-------
+[JuliaFEM/src/interfaces.jl:22](https://github.com/JuliaFEM/JuliaFEM.jl/tree/08077a783a6459336cf07b02e323df0e9977c74f/src/interfaces.jl#L22)
+

docs/api/JuliaFEM.rst

@@ -0,0 +1,3 @@
+JuliaFEM
+========
+

docs/api/JuliaFEM.xdmf.rst

@@ -0,0 +1,3 @@
+JuliaFEM.xdmf
+=============
+

docs/build_api.jl

@@ -41,6 +41,7 @@ const modules = append_list
 # run(`cp $main_folder/$file_ $this_folder`)
 
 cd(dirname(@__FILE__)) do
+<<<<<<< HEAD
     # Run the doctests *before* we start to generate *any* documentation.
 #    for m in modules
 #        failures = failed(doctest(m))
@@ -50,11 +51,14 @@ cd(dirname(@__FILE__)) do
 #            exit(1) # Bail when doctests fail.
 #        end
 #    end
+=======
+>>>>>>> origin/master
     # Generate and save the contents of docstrings as markdown files.
     index  = Index()
     for mod in modules
         Lexicon.update!(index, save(joinpath(api_directory, "$(mod).rst"), mod))
     end
+<<<<<<< HEAD
     #save(joinpath(api_directory, "index.rst"))
 
     # Add a reminder not to edit the generated files.
@@ -64,35 +68,11 @@ cd(dirname(@__FILE__)) do
   #      all changes to the originating docstrings/files rather than these ones.
   #      """)
   #  end
+=======
+    # save(joinpath(api_directory, "index.rst"), index; md_subheader = :category)
+>>>>>>> origin/master
 
     # info("Adding all documentation changes in $(api_directory) to this commit.")
     # success(`git add $(api_directory)`) || exit(1)
 
 end
-
-# point of this?
-#cd(dirname(dirname(@__FILE__))) do
-#    yaml = """
-#    # This is automatically generated by docs/build.jl. Edit that file if you
-#    # wish to make any permenant changes.
-#    site_name: JuliaFEM.jl
-#    site_description: JuliaFEM.jl, open-source software for reliable, scalable, distributed Finite Element Method.
-#    repo_name: GitHub
-#    # docs_dir: 'docs'
-#    # site_dir: 'site'
-#    repo_url: https://github.com/JuliaFEM/JuliaFEM.jl
-#    pages:
-#    - Home: 'index.md'
-#    #- API Docs:
-#    - JuliaFEM: 'api/JuliaFEM.md'
-#    - JuliaFEM.elasticity_solver: 'api/JuliaFEM.elasticity_solver.md'
-#    theme: readthedocs
-#    """
-#
-#    # TODO: add the solutions if I figure out how to get them to render properly
-#
-#    open("mkdocs.yml", "w") do f
-#        write(f, yaml)
-#    end
-#end
-

docs/source/modules.rst

@@ -0,0 +1,6 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+