m_a3_output Module Reference

This module contains routines for writing output files with Afivo. The Silo format should probably be used for larger files, especially in 3D. More...

Functions/Subroutines
subroutine, public	a3_prepend_directory (filename, dir, out_name)
subroutine, public	a3_write_tree (tree, filename, dir)
	Write full tree in binary format. More...
subroutine, public	a3_read_tree (tree, filename)
	Read full tree in binary format. More...
subroutine, public	a3_tree_copy_variable (tree_from, ivs_from, tree_to, ivs_to)
subroutine, public	a3_write_line (tree, filename, ivs, r_min, r_max, n_points, dir)
	Write line data in a text file. More...
subroutine, public	a3_write_plane (tree, filename, ivs, r_min, r_max, n_pixels, dir)
	Write data in a plane (2D) to a VTK ASCII file. In 3D, r_min and r_max should have one identical coordinate (i.e., they differ in two coordinates). More...
subroutine, public	a3_write_vtk (tree, filename, n_cycle, time, ixs_cc, dir, add_vars, add_names)
	Write the cell centered data of a tree to a vtk unstructured file. Only the leaves of the tree are used. More...
subroutine, public	a3_write_silo (tree, filename, n_cycle, time, ixs_cc, dir, add_vars, add_names)
	Write the cell centered data of a tree to a Silo file. Only the leaves of the tree are used. More...

Detailed Description

This module contains routines for writing output files with Afivo. The Silo format should probably be used for larger files, especially in 3D.

Function/Subroutine Documentation

a3_prepend_directory()

subroutine, public m_a3_output::a3_prepend_directory	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in), optional	dir,
		character(len=*), intent(inout)	out_name
	)

Definition at line 33 of file m_a3_output.f90.

a3_write_tree()

subroutine, public m_a3_output::a3_write_tree	(	type(a3_t), intent(in)	tree,
		character(len=*), intent(in)	filename,
		character(len=*), intent(in), optional	dir
	)

Write full tree in binary format.

Parameters

[in]	tree	Tree to write out
[in]	filename	Filename for the output
[in]	dir	Directory to place output in

Definition at line 55 of file m_a3_output.f90.

a3_read_tree()

subroutine, public m_a3_output::a3_read_tree	(	type(a3_t), intent(out)	tree,
		character(len=*), intent(in)	filename
	)

Read full tree in binary format.

Parameters

[out]	tree	Tree to read in
[in]	filename	Filename for the input

Definition at line 118 of file m_a3_output.f90.

a3_tree_copy_variable()

subroutine, public m_a3_output::a3_tree_copy_variable	(	type(a3_t), intent(in)	tree_from,
		integer, dimension(:), intent(in)	ivs_from,
		type(a3_t), intent(inout)	tree_to,
		integer, dimension(:), intent(in)	ivs_to
	)

Parameters

[in]	tree_from	Copy from this grid
[in]	ivs_from	From these variable
[in,out]	tree_to	Copy to this grid
[in]	ivs_to	To these variable

Definition at line 194 of file m_a3_output.f90.

a3_write_line()

subroutine, public m_a3_output::a3_write_line	(	type(a3_t), intent(in)	tree,
		character(len=*), intent(in)	filename,
		integer, dimension(:), intent(in)	ivs,
		real(dp), dimension(3), intent(in)	r_min,
		real(dp), dimension(3), intent(in)	r_max,
		integer, intent(in)	n_points,
		character(len=*), intent(in), optional	dir
	)

Write line data in a text file.

Parameters

[in]	tree	Tree to write out
[in]	filename	Filename for the vtk file
[in]	ivs	Variables to write
[in]	r_min	Minimum coordinate of line
[in]	r_max	Maximum coordinate of line
[in]	n_points	Number of points along line
[in]	dir	Directory to place files in

Definition at line 226 of file m_a3_output.f90.

a3_write_plane()

subroutine, public m_a3_output::a3_write_plane	(	type(a3_t), intent(in)	tree,
		character(len=*), intent(in)	filename,
		integer, dimension(:), intent(in)	ivs,
		real(dp), dimension(3), intent(in)	r_min,
		real(dp), dimension(3), intent(in)	r_max,
		integer, dimension(2), intent(in)	n_pixels,
		character(len=*), intent(in), optional	dir
	)

Write data in a plane (2D) to a VTK ASCII file. In 3D, r_min and r_max should have one identical coordinate (i.e., they differ in two coordinates).

Parameters

[in]	tree	Tree to write out
[in]	filename	Filename for the vtk file
[in]	ivs	Variables to write
[in]	r_min	Minimum coordinate of plane
[in]	r_max	Maximum coordinate of plane
[in]	n_pixels	Number of pixels in the plane
[in]	dir	Directory to place files in

Definition at line 276 of file m_a3_output.f90.

a3_write_vtk()

subroutine, public m_a3_output::a3_write_vtk	(	type(a3_t), intent(in)	tree,
		character(len=*), intent(in)	filename,
		integer, intent(in), optional	n_cycle,
		real(dp), intent(in), optional	time,
		integer, dimension(:), intent(in), optional	ixs_cc,
		character(len=*), intent(in), optional	dir,
		procedure(subr_add_vars), optional	add_vars,
		character(len=*), dimension(:), intent(in), optional	add_names
	)

Write the cell centered data of a tree to a vtk unstructured file. Only the leaves of the tree are used.

Parameters

[in]	tree	Tree to write out
[in]	filename	Filename for the vtk file
[in]	n_cycle	Cycle-number for vtk file (counter)
[in]	time	Time for output file
[in]	ixs_cc	Oncly include these cell variables
[in]	dir	Directory to place files in
	add_vars	Optional routine to add extra variables
[in]	add_names	Names of extra variables

Definition at line 351 of file m_a3_output.f90.

a3_write_silo()

subroutine, public m_a3_output::a3_write_silo	(	type(a3_t), intent(in)	tree,
		character(len=*)	filename,
		integer, intent(in), optional	n_cycle,
		real(dp), intent(in), optional	time,
		integer, dimension(:), intent(in), optional	ixs_cc,
		character(len=*), intent(in), optional	dir,
		procedure(subr_add_vars), optional	add_vars,
		character(len=*), dimension(:), intent(in), optional	add_names
	)

Write the cell centered data of a tree to a Silo file. Only the leaves of the tree are used.

Parameters

[in]	tree	Tree to write out
	filename	Filename for the vtk file
[in]	n_cycle	Cycle-number for vtk file (counter)
[in]	time	Time for output file
[in]	ixs_cc	Oncly include these cell variables
[in]	dir	Directory to place files in
	add_vars	Optional routine to add extra variables
[in]	add_names	Names of extra variables

Definition at line 493 of file m_a3_output.f90.