SolutionIndexer< dim, number > Class Template Reference

Class that provides access to solution vectors spread across different groups. More...

#include <solution_indexer.h>

Public Member Functions
	SolutionIndexer (unsigned int num_fields, std::vector< GroupSolutionHandler< dim, number > * > solution_handlers)
	Constructor.
const SolutionVector< number > &	get_solution_vector (unsigned int global_index, unsigned int relative_level=0) const
	Get a solution vector of a given field index.
SolutionVector< number > &	get_solution_vector (unsigned int global_index, unsigned int relative_level=0)
	Get a solution vector of a given field index.
const SolutionVector< number > &	get_old_solution_vector (unsigned int age, unsigned int global_index, unsigned int relative_level=0) const
	Get a solution vector of a given field index at a given age.
SolutionVector< number > &	get_old_solution_vector (unsigned int age, unsigned int global_index, unsigned int relative_level=0)
	Get a solution vector of a given field index at a given age.
const MatrixFree< dim, number > &	get_matrix_free (unsigned int index, unsigned int relative_level=0) const
	Get the matrixfree object of the group a given field index.
MatrixFree< dim, number > &	get_matrix_free (unsigned int index, unsigned int relative_level=0)
	Get the matrixfree object of the group a given field index.
const SolveGroup &	get_solve_group (unsigned int index) const
	Get the solve group of a given field index.
std::pair< const SolutionLevel< dim, number > *, unsigned int >	get_solution_level_and_block_index (unsigned int index, unsigned int relative_level=0) const
	Get the matrixfree object of the group a given field index.
unsigned int	get_block_index (unsigned int global_index) const
	Get the block index of a field within its solve group.

Private Attributes
std::vector< GroupSolutionHandler< dim, number > * >	solutions

Detailed Description

template<unsigned int dim, typename number>
class SolutionIndexer< dim, number >

Class that provides access to solution vectors spread across different groups.

Constructor & Destructor Documentation

SolutionIndexer()

template<unsigned int dim, typename number >

PRISMS_PF_BEGIN_NAMESPACE SolutionIndexer< dim, number >::SolutionIndexer	(	unsigned int	num_fields,
		std::vector< GroupSolutionHandler< dim, number > * >	solution_handlers
	)

Constructor.

Member Function Documentation

get_block_index()

template<unsigned int dim, typename number >

unsigned int SolutionIndexer< dim, number >::get_block_index

(

unsigned int

global_index

)

const

Get the block index of a field within its solve group.

get_matrix_free() [1/2]

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_matrix_free	(	unsigned int	index,
		unsigned int	relative_level = 0
	)

Get the matrixfree object of the group a given field index.

get_matrix_free() [2/2]

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_matrix_free	(	unsigned int	index,
		unsigned int	relative_level = 0
	)		const

Get the matrixfree object of the group a given field index.

get_old_solution_vector() [1/2]

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_old_solution_vector	(	unsigned int	age,
		unsigned int	global_index,
		unsigned int	relative_level = 0
	)

Get a solution vector of a given field index at a given age.

get_old_solution_vector() [2/2]

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_old_solution_vector	(	unsigned int	age,
		unsigned int	global_index,
		unsigned int	relative_level = 0
	)		const

Get a solution vector of a given field index at a given age.

get_solution_level_and_block_index()

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_solution_level_and_block_index	(	unsigned int	index,
		unsigned int	relative_level = 0
	)		const

Get the matrixfree object of the group a given field index.

get_solution_vector() [1/2]

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_solution_vector	(	unsigned int	global_index,
		unsigned int	relative_level = 0
	)

Get a solution vector of a given field index.

get_solution_vector() [2/2]

template<unsigned int dim, typename number >

auto SolutionIndexer< dim, number >::get_solution_vector	(	unsigned int	global_index,
		unsigned int	relative_level = 0
	)		const

Get a solution vector of a given field index.

get_solve_group()

template<unsigned int dim, typename number >

const SolveGroup & SolutionIndexer< dim, number >::get_solve_group

(

unsigned int

index

)

const

Get the solve group of a given field index.

Member Data Documentation

solutions

template<unsigned int dim, typename number >

std::vector<GroupSolutionHandler<dim, number> *> SolutionIndexer< dim, number >::solutions

private

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/core/solution_indexer.h
• /home/runner/work/phaseField/phaseField/src/core/solution_indexer.cc