Octopus
vtk_oct_m Module Reference

Functions/Subroutines

subroutine, public dvtk_out_cf (filename, namespace, fieldname, ierr, cf_in, cube, spacing, unit)
 Writes a cube_function in VTK legacy format see http: More...
 
subroutine, public dvtk_out_cf_vector (filename, namespace, fieldname, ierr, cf_in, vector_dim, cube, spacing, unit)
 Writes a cube_function in VTK legacy format see http: More...
 
subroutine, public dvtk_out_cf_structured (filename, namespace, fieldname, ierr, cf_in, cube, unit, points, ascii)
 Writes a mesh_function in VTK legacy format for structured grid data (i.e. curvilinear coordinates). The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space. More...
 
subroutine, public dvtk_out_bz_structured (filename, namespace, fieldname, ierr, axis, fin, unit, points1BZ, ascii)
 Writes a mesh_function in VTK legacy format for structured grid data in reciprocal space. The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space. More...
 
subroutine, public zvtk_out_cf (filename, namespace, fieldname, ierr, cf_in, cube, spacing, unit)
 Writes a cube_function in VTK legacy format see http: More...
 
subroutine, public zvtk_out_cf_vector (filename, namespace, fieldname, ierr, cf_in, vector_dim, cube, spacing, unit)
 Writes a cube_function in VTK legacy format see http: More...
 
subroutine, public zvtk_out_cf_structured (filename, namespace, fieldname, ierr, cf_in, cube, unit, points, ascii)
 Writes a mesh_function in VTK legacy format for structured grid data (i.e. curvilinear coordinates). The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space. More...
 
subroutine, public zvtk_out_bz_structured (filename, namespace, fieldname, ierr, axis, fin, unit, points1BZ, ascii)
 Writes a mesh_function in VTK legacy format for structured grid data in reciprocal space. The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space. More...
 

Function/Subroutine Documentation

◆ dvtk_out_cf()

subroutine, public vtk_oct_m::dvtk_out_cf ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
type(cube_function_t), intent(in)  cf_in,
type(cube_t), intent(in)  cube,
real(real64), dimension(:), intent(in)  spacing,
type(unit_t), intent(in)  unit 
)

Writes a cube_function in VTK legacy format see http:

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]cf_inthe cube_function to be written
[in]cubethe underlying cube mesh
[in]spacingthe mesh spacing already converted to units_out
[in]unitunit of data in cf

Definition at line 214 of file vtk.F90.

◆ dvtk_out_cf_vector()

subroutine, public vtk_oct_m::dvtk_out_cf_vector ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
type(cube_function_t), dimension(:), intent(in)  cf_in,
integer, intent(in)  vector_dim,
type(cube_t), intent(in)  cube,
real(real64), dimension(:), intent(in)  spacing,
type(unit_t), intent(in)  unit 
)

Writes a cube_function in VTK legacy format see http:

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]cf_inthe cube_function to be written
[in]cubethe underlying cube mesh
[in]spacingthe mesh spacing already converted to units_out
[in]unitunit of data in cf

Definition at line 280 of file vtk.F90.

◆ dvtk_out_cf_structured()

subroutine, public vtk_oct_m::dvtk_out_cf_structured ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
type(cube_function_t), intent(in)  cf_in,
type(cube_t), intent(in)  cube,
type(unit_t), intent(in)  unit,
real(real64), dimension(:,:,:,:), intent(in)  points,
logical, intent(in), optional  ascii 
)

Writes a mesh_function in VTK legacy format for structured grid data (i.e. curvilinear coordinates). The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space.

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]cf_inthe cube_function to be written
[in]cubethe underlying cube mesh
[in]unitunit of data in cf
[in]pointspoints(x,y,z,1:3): point coordinates in units_out

Definition at line 352 of file vtk.F90.

◆ dvtk_out_bz_structured()

subroutine, public vtk_oct_m::dvtk_out_bz_structured ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
integer, dimension(3), intent(in)  axis,
real(real64), dimension(:), intent(in)  fin,
type(unit_t), intent(in)  unit,
real(real64), dimension(:,:), intent(in)  points1BZ,
logical, intent(in), optional  ascii 
)

Writes a mesh_function in VTK legacy format for structured grid data in reciprocal space. The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space.

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]axisaxis defining the Brillouin zone
[in]finthe function to be written
[in]unitunit of data in cf
[in]points1bzpoints1BZ(1:3,nik): k-point coordinates

Definition at line 492 of file vtk.F90.

◆ zvtk_out_cf()

subroutine, public vtk_oct_m::zvtk_out_cf ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
type(cube_function_t), intent(in)  cf_in,
type(cube_t), intent(in)  cube,
real(real64), dimension(:), intent(in)  spacing,
type(unit_t), intent(in)  unit 
)

Writes a cube_function in VTK legacy format see http:

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]cf_inthe cube_function to be written
[in]cubethe underlying cube mesh
[in]spacingthe mesh spacing already converted to units_out
[in]unitunit of data in cf

Definition at line 668 of file vtk.F90.

◆ zvtk_out_cf_vector()

subroutine, public vtk_oct_m::zvtk_out_cf_vector ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
type(cube_function_t), dimension(:), intent(in)  cf_in,
integer, intent(in)  vector_dim,
type(cube_t), intent(in)  cube,
real(real64), dimension(:), intent(in)  spacing,
type(unit_t), intent(in)  unit 
)

Writes a cube_function in VTK legacy format see http:

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]cf_inthe cube_function to be written
[in]cubethe underlying cube mesh
[in]spacingthe mesh spacing already converted to units_out
[in]unitunit of data in cf

Definition at line 749 of file vtk.F90.

◆ zvtk_out_cf_structured()

subroutine, public vtk_oct_m::zvtk_out_cf_structured ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
type(cube_function_t), intent(in)  cf_in,
type(cube_t), intent(in)  cube,
type(unit_t), intent(in)  unit,
real(real64), dimension(:,:,:,:), intent(in)  points,
logical, intent(in), optional  ascii 
)

Writes a mesh_function in VTK legacy format for structured grid data (i.e. curvilinear coordinates). The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space.

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]cf_inthe cube_function to be written
[in]cubethe underlying cube mesh
[in]unitunit of data in cf
[in]pointspoints(x,y,z,1:3): point coordinates in units_out

Definition at line 846 of file vtk.F90.

◆ zvtk_out_bz_structured()

subroutine, public vtk_oct_m::zvtk_out_bz_structured ( character(len=*), intent(in)  filename,
type(namespace_t), intent(in)  namespace,
character(len=*), intent(in)  fieldname,
integer, intent(out)  ierr,
integer, dimension(3), intent(in)  axis,
complex(real64), dimension(:), intent(in)  fin,
type(unit_t), intent(in)  unit,
real(real64), dimension(:,:), intent(in)  points1BZ,
logical, intent(in), optional  ascii 
)

Writes a mesh_function in VTK legacy format for structured grid data in reciprocal space. The data is defined on a mesh that is topologically equivalent to a cubic grid. In other words, it must be laid on a cubic array but the value of each point coordinate is free in space.

Parameters
[in]filenamethe file name
[in]namespacenamespace for directory
[in]fieldnamethe name of the field
[out]ierrerror message
[in]axisaxis defining the Brillouin zone
[in]finthe function to be written
[in]unitunit of data in cf
[in]points1bzpoints1BZ(1:3,nik): k-point coordinates

Definition at line 1000 of file vtk.F90.