From fde25595d8e36c16403a3d5bd9765b59d548840e Mon Sep 17 00:00:00 2001
From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Fri, 3 Apr 2020 16:57:24 -0600
Subject: [PATCH] Add tests for complex-valued vector fields.

---
 tests/data_out/data_out_complex_05.cc     | 129 ++++++++++++++++++++++
 tests/data_out/data_out_complex_05.output |  81 ++++++++++++++
 tests/data_out/data_out_complex_06.cc     | 129 ++++++++++++++++++++++
 tests/data_out/data_out_complex_06.output |  88 +++++++++++++++
 4 files changed, 427 insertions(+)
 create mode 100644 tests/data_out/data_out_complex_05.cc
 create mode 100644 tests/data_out/data_out_complex_05.output
 create mode 100644 tests/data_out/data_out_complex_06.cc
 create mode 100644 tests/data_out/data_out_complex_06.output

diff --git a/tests/data_out/data_out_complex_05.cc b/tests/data_out/data_out_complex_05.cc
new file mode 100644
index 0000000000..1084c7ad35
--- /dev/null
+++ b/tests/data_out/data_out_complex_05.cc
@@ -0,0 +1,129 @@
+// ---------------------------------------------------------------------
+//
+// Copyright (C) 2017 - 2018 by the deal.II authors
+//
+// This file is part of the deal.II library.
+//
+// The deal.II library is free software; you can use it, redistribute
+// it, and/or modify it under the terms of the GNU Lesser General
+// Public License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+// The full text of the license can be found in the file LICENSE.md at
+// the top level directory of deal.II.
+//
+// ---------------------------------------------------------------------
+
+
+// Check DataOut for complex vectors. The finite element used here is
+// vector-valued, and we want to output both real and imaginary parts
+// of the vector as separate real-valued vector fields. For this,
+// DataOut needed to learn that it needs to duplicate not only the
+// vector, but keep the dim real parts together, the dim complex parts
+// together, and describe everything necessary to DataOutBase.
+//
+// This test checks the output in .gnuplot format.
+
+#include <deal.II/base/logstream.h>
+
+#include <deal.II/dofs/dof_accessor.h>
+#include <deal.II/dofs/dof_handler.h>
+#include <deal.II/dofs/dof_tools.h>
+
+#include <deal.II/fe/fe_q.h>
+#include <deal.II/fe/fe_system.h>
+
+#include <deal.II/grid/grid_generator.h>
+#include <deal.II/grid/tria.h>
+#include <deal.II/grid/tria_iterator.h>
+
+#include <deal.II/lac/block_vector.h>
+#include <deal.II/lac/vector.h>
+
+#include <deal.II/numerics/data_out.h>
+
+#include <fstream>
+#include <iomanip>
+#include <string>
+
+#include "../tests.h"
+
+
+
+template <int dim>
+void
+check()
+{
+  Triangulation<dim> tria;
+  GridGenerator::hyper_cube(tria, 0., 1.);
+
+  // Create a vector-valued finite element
+  FESystem<dim>   fe(FE_Q<dim>(1), dim);
+  DoFHandler<dim> dof_handler(tria);
+  dof_handler.distribute_dofs(fe);
+
+  // Pick a special solution function: constant in space, but one
+  // where the individual vector components have the form c-c*i
+  // (counting components from 1, for uniqueness of components). This
+  // allows us to check that the ordering of components in the output
+  // file is correct.
+  //
+  // For example, in 2d, the ordering of output components should then
+  // be
+  //   [1 2] [-1 -2]
+  // where [...] indicates which components jointly form a vector.
+  Vector<std::complex<double>> v(dof_handler.n_dofs());
+  for (unsigned int i = 0; i < v.size(); ++i)
+    v(i) = std::complex<double>(1, -1) * double(i % fe.n_components() + 1);
+
+  DataOut<dim> data_out;
+  data_out.attach_dof_handler(dof_handler);
+  data_out.add_data_vector(
+    v,
+    std::vector<std::string>(dim, "vector_field"),
+    DataOut<dim>::type_dof_data,
+    std::vector<DataComponentInterpretation::DataComponentInterpretation>(
+      dim, DataComponentInterpretation::component_is_part_of_vector));
+  data_out.build_patches();
+
+  data_out.write_gnuplot(deallog.get_file_stream());
+}
+
+
+
+int
+main()
+{
+  initlog();
+
+  try
+    {
+      check<1>();
+      check<2>();
+      check<3>();
+    }
+  catch (std::exception &exc)
+    {
+      deallog << std::endl
+              << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      deallog << "Exception on processing: " << std::endl
+              << exc.what() << std::endl
+              << "Aborting!" << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      return 1;
+    }
+  catch (...)
+    {
+      deallog << std::endl
+              << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      deallog << "Unknown exception!" << std::endl
+              << "Aborting!" << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      return 1;
+    }
+}
diff --git a/tests/data_out/data_out_complex_05.output b/tests/data_out/data_out_complex_05.output
new file mode 100644
index 0000000000..d2242b57d4
--- /dev/null
+++ b/tests/data_out/data_out_complex_05.output
@@ -0,0 +1,81 @@
+
+# This file was generated by the deal.II library.
+
+
+#
+# For a description of the GNUPLOT format see the GNUPLOT manual.
+#
+# <x> <vector_field_re> <vector_field_im> 
+0.00000 1.00000 -1.00000 
+1.00000 1.00000 -1.00000 
+
+
+# This file was generated by the deal.II library.
+
+
+#
+# For a description of the GNUPLOT format see the GNUPLOT manual.
+#
+# <x> <y> <vector_field_re> <vector_field_re> <vector_field_im> <vector_field_im> 
+0.00000 0.00000 1.00000 2.00000 -1.00000 -2.00000 
+1.00000 0.00000 1.00000 2.00000 -1.00000 -2.00000 
+
+0.00000 1.00000 1.00000 2.00000 -1.00000 -2.00000 
+1.00000 1.00000 1.00000 2.00000 -1.00000 -2.00000 
+
+
+# This file was generated by the deal.II library.
+
+
+#
+# For a description of the GNUPLOT format see the GNUPLOT manual.
+#
+# <x> <y> <z> <vector_field_re> <vector_field_re> <vector_field_re> <vector_field_im> <vector_field_im> <vector_field_im> 
+0.00000 0.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 0.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 0.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+0.00000 1.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 0.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+0.00000 0.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+1.00000 0.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 1.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+1.00000 0.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 0.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 1.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 1.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 1.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+0.00000 1.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+1.00000 1.00000 0.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 1.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 0.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 0.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 0.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+0.00000 1.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+1.00000 0.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 1.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
+0.00000 1.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+1.00000 1.00000 1.00000 1.00000 2.00000 3.00000 -1.00000 -2.00000 -3.00000
+
+
diff --git a/tests/data_out/data_out_complex_06.cc b/tests/data_out/data_out_complex_06.cc
new file mode 100644
index 0000000000..9ec568d20b
--- /dev/null
+++ b/tests/data_out/data_out_complex_06.cc
@@ -0,0 +1,129 @@
+// ---------------------------------------------------------------------
+//
+// Copyright (C) 2017 - 2018 by the deal.II authors
+//
+// This file is part of the deal.II library.
+//
+// The deal.II library is free software; you can use it, redistribute
+// it, and/or modify it under the terms of the GNU Lesser General
+// Public License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+// The full text of the license can be found in the file LICENSE.md at
+// the top level directory of deal.II.
+//
+// ---------------------------------------------------------------------
+
+
+// Check DataOut for complex vectors. The finite element used here is
+// vector-valued, and we want to output both real and imaginary parts
+// of the vector as separate real-valued vector fields. For this,
+// DataOut needed to learn that it needs to duplicate not only the
+// vector, but keep the dim real parts together, the dim complex parts
+// together, and describe everything necessary to DataOutBase.
+//
+// This test checks the output in .vtk format.
+
+#include <deal.II/base/logstream.h>
+
+#include <deal.II/dofs/dof_accessor.h>
+#include <deal.II/dofs/dof_handler.h>
+#include <deal.II/dofs/dof_tools.h>
+
+#include <deal.II/fe/fe_q.h>
+#include <deal.II/fe/fe_system.h>
+
+#include <deal.II/grid/grid_generator.h>
+#include <deal.II/grid/tria.h>
+#include <deal.II/grid/tria_iterator.h>
+
+#include <deal.II/lac/block_vector.h>
+#include <deal.II/lac/vector.h>
+
+#include <deal.II/numerics/data_out.h>
+
+#include <fstream>
+#include <iomanip>
+#include <string>
+
+#include "../tests.h"
+
+
+
+template <int dim>
+void
+check()
+{
+  Triangulation<dim> tria;
+  GridGenerator::hyper_cube(tria, 0., 1.);
+
+  // Create a vector-valued finite element
+  FESystem<dim>   fe(FE_Q<dim>(1), dim);
+  DoFHandler<dim> dof_handler(tria);
+  dof_handler.distribute_dofs(fe);
+
+  // Pick a special solution function: constant in space, but one
+  // where the individual vector components have the form c-c*i
+  // (counting components from 1, for uniqueness of components). This
+  // allows us to check that the ordering of components in the output
+  // file is correct.
+  //
+  // For example, in 2d, the ordering of output components should then
+  // be
+  //   [1 2] [-1 -2]
+  // where [...] indicates which components jointly form a vector.
+  Vector<std::complex<double>> v(dof_handler.n_dofs());
+  for (unsigned int i = 0; i < v.size(); ++i)
+    v(i) = std::complex<double>(1, -1) * double(i % fe.n_components() + 1);
+
+  DataOut<dim> data_out;
+  data_out.attach_dof_handler(dof_handler);
+  data_out.add_data_vector(
+    v,
+    std::vector<std::string>(dim, "vector_field"),
+    DataOut<dim>::type_dof_data,
+    std::vector<DataComponentInterpretation::DataComponentInterpretation>(
+      dim, DataComponentInterpretation::component_is_part_of_vector));
+  data_out.build_patches();
+
+  data_out.write_vtk(deallog.get_file_stream());
+}
+
+
+
+int
+main()
+{
+  initlog();
+
+  try
+    {
+      check<1>();
+      check<2>();
+      check<3>();
+    }
+  catch (std::exception &exc)
+    {
+      deallog << std::endl
+              << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      deallog << "Exception on processing: " << std::endl
+              << exc.what() << std::endl
+              << "Aborting!" << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      return 1;
+    }
+  catch (...)
+    {
+      deallog << std::endl
+              << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      deallog << "Unknown exception!" << std::endl
+              << "Aborting!" << std::endl
+              << "----------------------------------------------------"
+              << std::endl;
+      return 1;
+    }
+}
diff --git a/tests/data_out/data_out_complex_06.output b/tests/data_out/data_out_complex_06.output
new file mode 100644
index 0000000000..242170639c
--- /dev/null
+++ b/tests/data_out/data_out_complex_06.output
@@ -0,0 +1,88 @@
+
+# vtk DataFile Version 3.0
+#This file was generated 
+ASCII
+DATASET UNSTRUCTURED_GRID
+
+POINTS 2 double
+0.00000 0 0
+1.00000 0 0
+
+CELLS 1 3
+2	0	1
+
+CELL_TYPES 1
+ 3
+POINT_DATA 2
+VECTORS vector_field_re double
+1.00000 0 0
+1.00000 0 0
+VECTORS vector_field_im double
+-1.00000 0 0
+-1.00000 0 0
+# vtk DataFile Version 3.0
+#This file was generated 
+ASCII
+DATASET UNSTRUCTURED_GRID
+
+POINTS 4 double
+0.00000 0.00000 0
+1.00000 0.00000 0
+0.00000 1.00000 0
+1.00000 1.00000 0
+
+CELLS 1 5
+4	0	1	3	2
+
+CELL_TYPES 1
+ 9
+POINT_DATA 4
+VECTORS vector_field_re double
+1.00000 2.00000 0
+1.00000 2.00000 0
+1.00000 2.00000 0
+1.00000 2.00000 0
+VECTORS vector_field_im double
+-1.00000 -2.00000 0
+-1.00000 -2.00000 0
+-1.00000 -2.00000 0
+-1.00000 -2.00000 0
+# vtk DataFile Version 3.0
+#This file was generated 
+ASCII
+DATASET UNSTRUCTURED_GRID
+
+POINTS 8 double
+0.00000 0.00000 0.00000
+1.00000 0.00000 0.00000
+0.00000 1.00000 0.00000
+1.00000 1.00000 0.00000
+0.00000 0.00000 1.00000
+1.00000 0.00000 1.00000
+0.00000 1.00000 1.00000
+1.00000 1.00000 1.00000
+
+CELLS 1 9
+8	0	1	3	2	4	5	7	6
+
+CELL_TYPES 1
+ 12
+POINT_DATA 8
+VECTORS vector_field_re double
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+1.00000 2.00000 3.00000
+VECTORS vector_field_im double
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
+-1.00000 -2.00000 -3.00000
-- 
2.39.5