ReadFieldBase< dim, number > Class Template Reference

#include <read_field_base.h>

Inheritance diagram for ReadFieldBase< dim, number >:

Collaboration diagram for ReadFieldBase< dim, number >:

Public Member Functions
	ReadFieldBase (const InitialConditionFile &_ic_file, const SpatialDiscretization< dim > &_spatial_discretization)
	Constructor.
virtual	~ReadFieldBase ()=default
	Destructor.
	ReadFieldBase (const ReadFieldBase &read_base)=delete
	Copy constructor.
ReadFieldBase &	operator= (const ReadFieldBase &read_base)=delete
	Copy assignment.
	ReadFieldBase (ReadFieldBase &&read_base) noexcept=delete
	Move constructor.
ReadFieldBase &	operator= (ReadFieldBase &&read_base) noexcept=delete
	Move assignment.
virtual void	print_file ()=0
	Print the input file for debugging.
virtual number	get_scalar_value (const dealii::Point< dim > &point, const std::string &scalar_name)=0
	Get scalar value for a given point.
virtual dealii::Vector< number >	get_vector_value (const dealii::Point< dim > &point, const std::string &vector_name)=0
	Get vector value for a given point.

Protected Attributes
const SpatialDiscretization< dim > &	spatial_discretization
	Spatial discretization object.
const InitialConditionFile &	ic_file
	Initial condition file object.

Constructor & Destructor Documentation

ReadFieldBase() [1/3]

template<unsigned int dim, typename number >

ReadFieldBase< dim, number >::ReadFieldBase	(	const InitialConditionFile &	_ic_file,
		const SpatialDiscretization< dim > &	_spatial_discretization
	)

Constructor.

~ReadFieldBase()

template<unsigned int dim, typename number >

virtual ReadFieldBase< dim, number >::~ReadFieldBase ( )

virtualdefault

Destructor.

ReadFieldBase() [2/3]

template<unsigned int dim, typename number >

ReadFieldBase< dim, number >::ReadFieldBase ( const ReadFieldBase< dim, number > &  read_base )

delete

Copy constructor.

ReadFieldBase() [3/3]

template<unsigned int dim, typename number >

ReadFieldBase< dim, number >::ReadFieldBase ( ReadFieldBase< dim, number > &&  read_base )

deletenoexcept

Move constructor.

Member Function Documentation

get_scalar_value()

template<unsigned int dim, typename number >

virtual number ReadFieldBase< dim, number >::get_scalar_value ( const dealii::Point< dim > &  point, const std::string &  scalar_name  )

pure virtual

Get scalar value for a given point.

Implemented in ReadBinary< dim, number >, and ReadUnstructuredVTK< dim, number >.

get_vector_value()

template<unsigned int dim, typename number >

virtual dealii::Vector< number > ReadFieldBase< dim, number >::get_vector_value ( const dealii::Point< dim > &  point, const std::string &  vector_name  )

pure virtual

Get vector value for a given point.

Implemented in ReadBinary< dim, number >, and ReadUnstructuredVTK< dim, number >.

operator=() [1/2]

template<unsigned int dim, typename number >

ReadFieldBase & ReadFieldBase< dim, number >::operator= ( const ReadFieldBase< dim, number > &  read_base )

delete

Copy assignment.

operator=() [2/2]

template<unsigned int dim, typename number >

ReadFieldBase & ReadFieldBase< dim, number >::operator= ( ReadFieldBase< dim, number > &&  read_base )

deletenoexcept

Move assignment.

print_file()

template<unsigned int dim, typename number >

virtual void ReadFieldBase< dim, number >::print_file ( )

pure virtual

Print the input file for debugging.

Implemented in ReadBinary< dim, number >, and ReadUnstructuredVTK< dim, number >.

Member Data Documentation

ic_file

template<unsigned int dim, typename number >

const InitialConditionFile& ReadFieldBase< dim, number >::ic_file

protected

Initial condition file object.

spatial_discretization

template<unsigned int dim, typename number >

const SpatialDiscretization<dim>& ReadFieldBase< dim, number >::spatial_discretization

protected

Spatial discretization object.

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/core/initial_conditions.h
• /home/runner/work/phaseField/phaseField/include/prismspf/field_input/read_field_base.h