SolutionTransfer derived class which is specifically for transferring solutions back and forth between a VolumeMesh and its associated BoundaryMesh. More...

#include <boundary_volume_solution_transfer.h>

Inheritance diagram for libMesh::BoundaryVolumeSolutionTransfer:

[legend]

Public Member Functions
	BoundaryVolumeSolutionTransfer (const Parallel::Communicator &comm_in)

virtual	~BoundaryVolumeSolutionTransfer ()

virtual void	transfer (const Variable &from_var, const Variable &to_var) override
	Transfer values from a Variable in a System associated with a volume mesh to a Variable in a System associated with the corresponding BoundaryMesh, or vice-versa. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Protected Attributes
const Parallel::Communicator &	_communicator

Private Member Functions
void	transfer_volume_boundary (const Variable &from_var, const Variable &to_var)
	Transfer values from volume mesh to boundary mesh. More...

void	transfer_boundary_volume (const Variable &from_var, const Variable &to_var)
	Transfer values from boundary mesh to volume mesh. More...

Detailed Description

SolutionTransfer derived class which is specifically for transferring solutions back and forth between a VolumeMesh and its associated BoundaryMesh.

That is, when calling transfer() below, we must have either:

.) Transfer from the boundary of a VolumeMesh to its associated BoundaryMesh, or .) Transfer from a BoundaryMesh to its corresponding VolumeMesh.

Because of this assumption, we can use the interior_parent() to directly define the mapping between solutions. The transfer() function internally determines which direction the transfer is going, and calls the appropriate algorithm internally.

Author: Xikai Jiang; John W. Peterson

Date: 2016

Definition at line 47 of file boundary_volume_solution_transfer.h.

Constructor & Destructor Documentation

◆ BoundaryVolumeSolutionTransfer()

libMesh::BoundaryVolumeSolutionTransfer::BoundaryVolumeSolutionTransfer ( const Parallel::Communicator & comm_in )

inline

Definition at line 50 of file boundary_volume_solution_transfer.h.

                                                                         :
     SolutionTransfer(comm_in)
   {}

◆ ~BoundaryVolumeSolutionTransfer()

virtual libMesh::BoundaryVolumeSolutionTransfer::~BoundaryVolumeSolutionTransfer ( )

inlinevirtual

Definition at line 54 of file boundary_volume_solution_transfer.h.

54 {}

Member Function Documentation

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inlineinherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 94 of file parallel_object.h.

95 { return _communicator; }

References libMesh::ParallelObject::_communicator.

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 100 of file parallel_object.h.

101 { return cast_int<processor_id_type>(_communicator.size()); }

References libMesh::ParallelObject::_communicator.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 106 of file parallel_object.h.

107 { return cast_int<processor_id_type>(_communicator.rank()); }

References libMesh::ParallelObject::_communicator.

◆ transfer()

void libMesh::BoundaryVolumeSolutionTransfer::transfer	(	const Variable &	from_var,
		const Variable &	to_var
	)

overridevirtual

Transfer values from a Variable in a System associated with a volume mesh to a Variable in a System associated with the corresponding BoundaryMesh, or vice-versa.

Implements libMesh::SolutionTransfer.

Definition at line 25 of file boundary_volume_solution_transfer.C.

 {
   // Determine which direction the transfer is in
   System * from_sys = from_var.system();
   System * to_sys = to_var.system();
  
   unsigned int
     from_dimension = from_sys->get_mesh().mesh_dimension(),
     to_dimension = to_sys->get_mesh().mesh_dimension();
  
   // Sanity check
   if (from_dimension == to_dimension)
     libmesh_error_msg("Error: Transfer must be from volume mesh to its boundary or vice-versa!");
  
   if (from_dimension > to_dimension)
     this->transfer_volume_boundary(from_var, to_var);
   else
     this->transfer_boundary_volume(from_var, to_var);
 }

References libMesh::System::get_mesh(), libMesh::MeshBase::mesh_dimension(), libMesh::Variable::system(), transfer_boundary_volume(), and transfer_volume_boundary().

◆ transfer_boundary_volume()

void libMesh::BoundaryVolumeSolutionTransfer::transfer_boundary_volume	(	const Variable &	from_var,
		const Variable &	to_var
	)

private

Transfer values from boundary mesh to volume mesh.

Called when needed from transfer().

Definition at line 149 of file boundary_volume_solution_transfer.C.

 {
   // Get references to the Systems from the Variables
   System * from_sys = from_var.system(); // boundary system
   System * to_sys = to_var.system();     // volume system
  
   // Get reference to BoundaryMesh.
   const MeshBase & from_mesh = from_sys->get_mesh();
  
   // DofMap for BoundaryMesh
   const DofMap & dof_map = from_sys->get_dof_map();
  
   // Get system number and variable numbers
   const unsigned int to_sys_number = to_sys->number();
   const unsigned int to_var_number = to_var.number();
   const unsigned int from_var_number = from_var.number();
   const unsigned int to_n_comp = to_var.n_components();
  
   // In order to get solution vectors from BoundaryMesh
   std::vector<dof_id_type> from_dof_indices;
   std::vector<Number> value;
  
   // Loop through all boundary elements.
   for (const auto & from_elem : from_mesh.active_local_element_ptr_range())
     {
       const Elem * to_elem = from_elem->interior_parent();
  
       if (!to_elem)
         libmesh_error_msg("Error, transfer must be between a Mesh and its associated BoundaryMesh.");
  
       // Get dof indices for phi2 for all nodes on this boundary element
       dof_map.dof_indices(from_elem, from_dof_indices, from_var_number);
  
       // Get values from BoundaryMesh for this element
       from_sys->current_local_solution->get(from_dof_indices, value);
  
       // loop through all nodes in each boundary element.
       for (auto node : from_elem->node_index_range())
         {
           // Node in boundary element.
           const Node * from_node = from_elem->node_ptr(node);
  
           // Nodes in interior_parent element.
           for (const Node & to_node : to_elem->node_ref_range())
             {
               // Match BoundaryNode & VolumeNode.
               if (to_node.absolute_fuzzy_equals(*from_node, TOLERANCE))
                 {
                   // Global dof_index for node in VolumeMesh.
                   const dof_id_type to_dof = to_node.dof_number(to_sys_number,
                                                                 to_var_number,
                                                                 to_n_comp - 1);
  
                   // Assign values to boundary in VolumeMesh.
                   to_sys->solution->set(to_dof, value[node]);
                 }
             }
         }
     }
 }

References libMesh::MeshBase::active_local_element_ptr_range(), libMesh::System::current_local_solution, libMesh::DofMap::dof_indices(), libMesh::DofObject::dof_number(), libMesh::System::get_dof_map(), libMesh::System::get_mesh(), libMesh::Elem::interior_parent(), libMesh::Variable::n_components(), libMesh::Elem::node_ref_range(), libMesh::Variable::number(), libMesh::System::number(), libMesh::System::solution, libMesh::Variable::system(), libMesh::TOLERANCE, and value.

Referenced by transfer().

◆ transfer_volume_boundary()

void libMesh::BoundaryVolumeSolutionTransfer::transfer_volume_boundary	(	const Variable &	from_var,
		const Variable &	to_var
	)

private

Transfer values from volume mesh to boundary mesh.

Called when needed from transfer().

Definition at line 49 of file boundary_volume_solution_transfer.C.

 {
   // Get references to the Systems from the Variables
   System * from_sys = from_var.system(); // volume system
   System * to_sys = to_var.system();     // boundary system
  
   // Get reference to the BoundaryMesh.  Note: we always loop over the
   // BoundaryMesh since, by definition, it has fewer dofs than the
   // volume mesh.
   const MeshBase & to_mesh = to_sys->get_mesh();
  
   // Get system number and variable numbers
   const unsigned int from_sys_number = from_sys->number();
   const unsigned int from_var_number = from_var.number();
  
   const unsigned int to_sys_number = to_sys->number();
   const unsigned int to_var_number = to_var.number();
  
   // Get a constant reference to variables, get their number of components
   const unsigned int from_n_comp = from_var.n_components();
   const unsigned int to_n_comp = to_var.n_components();
  
   // Sanity check that the variables have the same number of components
   libmesh_assert_equal_to(from_n_comp, to_n_comp);
  
   // Construct map from "from" dofs to "to" dofs.
   typedef std::map<numeric_index_type, numeric_index_type> DofMapping;
   DofMapping dof_mapping;
  
   // Loop through all boundary elements.
   for (const auto & to_elem : to_mesh.active_local_element_ptr_range())
     {
       const Elem * from_elem = to_elem->interior_parent();
  
       if (!from_elem)
         libmesh_error_msg("Error, transfer must be between a Mesh and its associated BoundaryMesh.");
  
       // loop through all nodes in each boundary element.
       for (const Node & to_node : to_elem->node_ref_range())
         {
           // Nodes in interior_parent element.
           for (const Node & from_node : from_elem->node_ref_range())
             {
               const dof_id_type from_dof = from_node.dof_number(from_sys_number,
                                                                 from_var_number,
                                                                 from_n_comp - 1);
  
               // See if we've already encountered this DOF in the loop
               // over boundary elements.
               DofMapping::iterator it = dof_mapping.find(from_dof);
  
               // If we've already mapped this dof, we don't need to map
               // it again or do floating point comparisons.
               if (it == dof_mapping.end() &&
                   from_node.absolute_fuzzy_equals(to_node, TOLERANCE))
                 {
                   // Global dof_index for node in BoundaryMesh.
                   const dof_id_type to_dof = to_node.dof_number(to_sys_number,
                                                                 to_var_number,
                                                                 to_n_comp - 1);
  
                   // Keep track of the volume system dof index which is needed.
                   dof_mapping[from_dof] = to_dof;
                 }
             }
         }
     }
  
   // Construct a vector of the indices needed from the Volume system's
   // global solution vector on this processor.
   std::vector<numeric_index_type> needed_indices;
   needed_indices.reserve(dof_mapping.size());
   {
     DofMapping::iterator
       it = dof_mapping.begin(),
       end = dof_mapping.end();
  
     for (; it!=end; ++it)
       needed_indices.push_back(it->first);
   }
  
   // Communicate just the required values without making a copy of the
   // global solution vector.
   std::vector<Number> needed_values;
   from_sys->solution->localize(needed_values, needed_indices);
  
   // Loop over DofMapping again, assigning values in the
   // Boundary System solution vector.
   {
     DofMapping::iterator
       it = dof_mapping.begin(),
       end = dof_mapping.end();
  
     for (unsigned idx=0; it!=end; ++it, ++idx)
       to_sys->solution->set(it->second, needed_values[idx]);
   }
 }

References libMesh::MeshBase::active_local_element_ptr_range(), end, libMesh::System::get_mesh(), libMesh::MeshTools::Generation::Private::idx(), libMesh::Elem::interior_parent(), libMesh::Variable::n_components(), libMesh::Elem::node_ref_range(), libMesh::Variable::number(), libMesh::System::number(), libMesh::System::solution, libMesh::Variable::system(), and libMesh::TOLERANCE.

Referenced by transfer().

Member Data Documentation

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 112 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

The documentation for this class was generated from the following files:

include/solution_transfer/boundary_volume_solution_transfer.h
src/solution_transfer/boundary_volume_solution_transfer.C

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BoundaryVolumeSolutionTransfer()

◆ ~BoundaryVolumeSolutionTransfer()

Member Function Documentation

◆ comm()

◆ n_processors()

◆ processor_id()

◆ transfer()

◆ transfer_boundary_volume()

◆ transfer_volume_boundary()

Member Data Documentation

◆ _communicator