#include <field.hh>

Collaboration diagram for FieldFE< spacedim, Value >:

[legend]

Classes
class	FEItem

class	NativeFactory

Public Types
enum	DataInterpolation { identic_msh, equivalent_msh, gauss_p0, interp_p0 }

typedef FieldAlgorithmBase< spacedim, Value >::Point	Point

typedef FieldAlgorithmBase< spacedim, Value >	FactoryBaseType

typedef Field< spacedim, Value >::FactoryBase	FieldFactoryBaseType

Public Member Functions
	TYPEDEF_ERR_INFO (EI_ElemIdx, unsigned int)

	DECLARE_EXCEPTION (ExcInvalidElemeDim,<< "Dimension of element in target mesh must be 0, 1 or 2! elm.idx() = "<< EI_ElemIdx::val<< ".\n")

	FieldFE (unsigned int n_comp=0)

VectorMPI	set_fe_data (std::shared_ptr< DOFHandlerMultiDim > dh, VectorMPI dof_values=VectorMPI::sequential(0), unsigned int block_index=FieldFE< spacedim, Value >::undef_uint)

virtual const Value::return_type &	value (const Point &p, const ElementAccessor< spacedim > &elm)

virtual void	value_list (const Armor::array &point_list, const ElementAccessor< spacedim > &elm, std::vector< typename Value::return_type > &value_list)

void	cache_update (FieldValueCache< typename Value::element_type > &data_cache, ElementCacheMap &cache_map, unsigned int region_patch_idx) override

void	cache_reinit (const ElementCacheMap &cache_map) override

virtual void	init_from_input (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)

bool	set_time (const TimeStep &time) override

void	set_mesh (const Mesh *mesh, bool boundary_domain) override

void	native_data_to_cache (ElementDataCache< double > &output_data_cache)

unsigned int	data_size () const

std::shared_ptr< DOFHandlerMultiDim >	get_dofhandler () const

VectorMPI &	vec ()

void	local_to_ghost_data_scatter_begin ()
	Call begin scatter functions (local to ghost) on data vector. More...

void	local_to_ghost_data_scatter_end ()
	Call end scatter functions (local to ghost) on data vector. More...

virtual	~FieldFE ()
	Destructor. More...

Static Public Member Functions
static const Input::Type::Record &	get_input_type ()
	Implementation. More...

static const Input::Type::Selection &	get_disc_selection_input_type ()

static const Input::Type::Selection &	get_interp_selection_input_type ()

Static Public Attributes
static const unsigned int	undef_uint = -1

Private Member Functions
void	make_dof_handler (const MeshBase *mesh)
	Create DofHandler object. More...

void	interpolate_gauss (ElementDataCache< double >::CacheData data_vec)
	Interpolate data (use Gaussian distribution) over all elements of target mesh. More...

void	interpolate_intersection (ElementDataCache< double >::CacheData data_vec)
	Interpolate data (use intersection library) over all elements of target mesh. More...

void	calculate_native_values (ElementDataCache< double >::CacheData data_cache)
	Calculate native data over all elements of target mesh. More...

void	calculate_identic_values (ElementDataCache< double >::CacheData data_cache)
	Calculate data of identict_mesh interpolation on input data over all elements of target mesh. More...

void	calculate_equivalent_values (ElementDataCache< double >::CacheData data_cache)
	Calculate data of equivalent_mesh interpolation on input over all elements of target mesh. More...

void	fill_boundary_dofs ()

template<unsigned int dim>
Quadrature	init_quad (std::shared_ptr< EvalPoints > eval_points)
	Initialize FEValues object of given dimension. More...

Armor::ArmaMat< typename Value::element_type, Value::NRows_, Value::NCols_ >	handle_fe_shape (unsigned int dim, unsigned int i_dof, unsigned int i_qp)

template<unsigned int dim>
void	fill_fe_system_data (unsigned int block_index)

template<unsigned int dim>
void	fill_fe_item ()

Private Attributes
std::shared_ptr< DOFHandlerMultiDim >	dh_
	DOF handler object. More...

VectorMPI	data_vec_
	Store data of Field. More...

FEValueHandler< 0, spacedim, Value >	value_handler0_
	Value handler that allows get value of 0D elements. More...

FEValueHandler< 1, spacedim, Value >	value_handler1_
	Value handler that allows get value of 1D elements. More...

FEValueHandler< 2, spacedim, Value >	value_handler2_
	Value handler that allows get value of 2D elements. More...

FEValueHandler< 3, spacedim, Value >	value_handler3_
	Value handler that allows get value of 3D elements. More...

FilePath	reader_file_
	mesh reader file More...

std::string	field_name_
	field name read from input More...

OutputTime::DiscreteSpace	discretization_
	Specify section where to find the field data in input mesh file. More...

DataInterpolation	interpolation_
	Specify type of FE data interpolation. More...

FieldFlag::Flags	flags_
	Field flags. More...

double	default_value_
	Default value of element if not set in mesh data file. More...

Input::Record	in_rec_
	Accessor to Input::Record. More...

bool	boundary_domain_
	Is set in set_mesh method. Value true means, that we accept only boundary element accessors in the `value` method. More...

std::shared_ptr< std::vector< IntIdx > >	boundary_dofs_

std::vector< FEValues< spacedim > >	fe_values_
	List of FEValues objects of dimensions 0,1,2,3 used for value calculation. More...

std::shared_ptr< EquivalentMeshMap >	source_target_mesh_elm_map_
	Maps element indices between source (data) and target (computational) mesh if data interpolation is set to equivalent_msh. More...

std::array< FEItem, 4 >	fe_item_
	Holds specific data of field evaluation over all dimensions. More...

MixedPtr< FiniteElement >	fe_

Static Private Attributes
static const int	registrar
	Registrar of class to factory. More...

Detailed Description

template<int spacedim, class Value>
class FieldFE< spacedim, Value >

Class representing fields given by finite element approximation.

Definition at line 59 of file field.hh.

Member Typedef Documentation

◆ FactoryBaseType

template<int spacedim, class Value >

typedef FieldAlgorithmBase<spacedim, Value> FieldFE< spacedim, Value >::FactoryBaseType

Definition at line 54 of file field_fe.hh.

◆ FieldFactoryBaseType

template<int spacedim, class Value >

typedef Field<spacedim, Value>::FactoryBase FieldFE< spacedim, Value >::FieldFactoryBaseType

Definition at line 55 of file field_fe.hh.

◆ Point

template<int spacedim, class Value >

typedef FieldAlgorithmBase<spacedim, Value>::Point FieldFE< spacedim, Value >::Point

Definition at line 53 of file field_fe.hh.

Member Enumeration Documentation

◆ DataInterpolation

template<int spacedim, class Value >

enum FieldFE::DataInterpolation

Possible interpolations of input data.

Enumerator
identic_msh	identical mesh
equivalent_msh	equivalent mesh (default value)
gauss_p0	P0 interpolation (with the use of Gaussian distribution)
interp_p0	P0 interpolation (with the use of calculation of intersections)

Definition at line 60 of file field_fe.hh.

Constructor & Destructor Documentation

◆ FieldFE()

template<int spacedim, class Value >

FieldFE< spacedim, Value >::FieldFE ( unsigned int n_comp = 0 )

Default constructor, optionally we need number of components n_comp in the case of Vector valued fields.

Definition at line 133 of file field_fe.cc.

◆ ~FieldFE()

template<int spacedim, class Value >

FieldFE< spacedim, Value >::~FieldFE

virtual

Destructor.

Definition at line 901 of file field_fe.cc.

Member Function Documentation

◆ cache_reinit()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::cache_reinit ( const ElementCacheMap & cache_map )

override

Overload FieldAlgorithmBase::cache_reinit

Reinit fe_values_ data member.

Definition at line 325 of file field_fe.cc.

◆ cache_update()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::cache_update	(	FieldValueCache< typename Value::element_type > &	data_cache,
		ElementCacheMap &	cache_map,
		unsigned int	region_patch_idx
	)

override

Overload FieldAlgorithmBase::cache_update

Definition at line 288 of file field_fe.cc.

◆ calculate_equivalent_values()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::calculate_equivalent_values ( ElementDataCache< double >::CacheData data_cache )

private

Calculate data of equivalent_mesh interpolation on input over all elements of target mesh.

Definition at line 809 of file field_fe.cc.

Here is the caller graph for this function:

◆ calculate_identic_values()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::calculate_identic_values ( ElementDataCache< double >::CacheData data_cache )

private

Calculate data of identict_mesh interpolation on input data over all elements of target mesh.

Definition at line 783 of file field_fe.cc.

Here is the caller graph for this function:

◆ calculate_native_values()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::calculate_native_values ( ElementDataCache< double >::CacheData data_cache )

private

Calculate native data over all elements of target mesh.

Definition at line 754 of file field_fe.cc.

Here is the caller graph for this function:

◆ data_size()

template<int spacedim, class Value >

unsigned int FieldFE< spacedim, Value >::data_size

inline

Return size of vector of data stored in Field

Definition at line 865 of file field_fe.cc.

◆ DECLARE_EXCEPTION()

template<int spacedim, class Value >

FieldFE< spacedim, Value >::DECLARE_EXCEPTION	(	ExcInvalidElemeDim	,
		<< "Dimension of element in target mesh must be	0
	)

◆ fill_boundary_dofs()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::fill_boundary_dofs

private

Fill data to boundary_dofs_ vector.

TODO: Temporary solution. REMOVE this method and fix all places where is boundary_dofs_ vector used.

Definition at line 406 of file field_fe.cc.

◆ fill_fe_item()

template<int spacedim, class Value >

template<unsigned int dim>

void FieldFE< spacedim, Value >::fill_fe_item ( )

inlineprivate

Definition at line 257 of file field_fe.hh.

◆ fill_fe_system_data()

template<int spacedim, class Value >

template<unsigned int dim>

void FieldFE< spacedim, Value >::fill_fe_system_data ( unsigned int block_index )

inlineprivate

Definition at line 247 of file field_fe.hh.

◆ get_disc_selection_input_type()

template<int spacedim, class Value >

const Input::Type::Selection & FieldFE< spacedim, Value >::get_disc_selection_input_type

static

Return Input selection for discretization type (determines the section of VTK file).

Definition at line 92 of file field_fe.cc.

◆ get_dofhandler()

template<int spacedim, class Value >

std::shared_ptr<DOFHandlerMultiDim> FieldFE< spacedim, Value >::get_dofhandler ( ) const

inline

Definition at line 177 of file field_fe.hh.

Here is the caller graph for this function:

◆ get_input_type()

template<int spacedim, class Value >

const Input::Type::Record & FieldFE< spacedim, Value >::get_input_type

static

Implementation.

Return Record for initialization of FieldFE that is derived from Abstract

Definition at line 61 of file field_fe.cc.

◆ get_interp_selection_input_type()

template<int spacedim, class Value >

const Input::Type::Selection & FieldFE< spacedim, Value >::get_interp_selection_input_type

static

Return Input selection that allow to set interpolation of input data.

Definition at line 104 of file field_fe.cc.

◆ handle_fe_shape()

template<int spacedim, class Value >

Armor::ArmaMat<typename Value::element_type, Value::NRows_, Value::NCols_> FieldFE< spacedim, Value >::handle_fe_shape	(	unsigned int	dim,
		unsigned int	i_dof,
		unsigned int	i_qp
	)

inlineprivate

Definition at line 234 of file field_fe.hh.

Here is the caller graph for this function:

◆ init_from_input()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::init_from_input	(	const Input::Record &	rec,
		const struct FieldAlgoBaseInitData &	init_data
	)

virtual

Initialization from the input interface.

Definition at line 348 of file field_fe.cc.

◆ init_quad()

template<int spacedim, class Value >

template<unsigned int dim>

Quadrature FieldFE< spacedim, Value >::init_quad ( std::shared_ptr< EvalPoints > eval_points )

private

Initialize FEValues object of given dimension.

Definition at line 338 of file field_fe.cc.

◆ interpolate_gauss()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::interpolate_gauss ( ElementDataCache< double >::CacheData data_vec )

private

Interpolate data (use Gaussian distribution) over all elements of target mesh.

Definition at line 558 of file field_fe.cc.

Here is the caller graph for this function:

◆ interpolate_intersection()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::interpolate_intersection ( ElementDataCache< double >::CacheData data_vec )

private

Interpolate data (use intersection library) over all elements of target mesh.

Definition at line 652 of file field_fe.cc.

Here is the caller graph for this function:

◆ local_to_ghost_data_scatter_begin()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::local_to_ghost_data_scatter_begin

Call begin scatter functions (local to ghost) on data vector.

Definition at line 872 of file field_fe.cc.

◆ local_to_ghost_data_scatter_end()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::local_to_ghost_data_scatter_end

Call end scatter functions (local to ghost) on data vector.

Definition at line 879 of file field_fe.cc.

◆ make_dof_handler()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::make_dof_handler ( const MeshBase * mesh )

private

Create DofHandler object.

Definition at line 433 of file field_fe.cc.

Here is the caller graph for this function:

◆ native_data_to_cache()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::native_data_to_cache ( ElementDataCache< double > & output_data_cache )

Copy data vector to given output ElementDataCache

Definition at line 846 of file field_fe.cc.

◆ set_fe_data()

template<int spacedim, class Value >

VectorMPI FieldFE< spacedim, Value >::set_fe_data	(	std::shared_ptr< DOFHandlerMultiDim >	dh,
		VectorMPI	dof_values = `VectorMPI::sequential(0)`,
		unsigned int	block_index = `FieldFE<spacedim, Value>::undef_uint`
	)

Setter for the finite element data.

Parameters

dh	Dof handler.
dof_values	Vector of dof values, optional (create own vector according to dofhandler).
block_index	Index of block (in FESystem) or '-1' for FieldFE under simple DOF handler.

Returns: Data vector of dof values.

Definition at line 173 of file field_fe.cc.

◆ set_mesh()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::set_mesh	(	const Mesh *	mesh,
		bool	boundary_domain
	)

override

Set target mesh.

Definition at line 371 of file field_fe.cc.

◆ set_time()

template<int spacedim, class Value >

bool FieldFE< spacedim, Value >::set_time ( const TimeStep & time )

override

Update time and possibly update data from GMSH file.

Definition at line 496 of file field_fe.cc.

◆ TYPEDEF_ERR_INFO()

template<int spacedim, class Value >

FieldFE< spacedim, Value >::TYPEDEF_ERR_INFO	(	EI_ElemIdx	,
		unsigned int
	)

◆ value()

template<int spacedim, class Value >

const Value::return_type & FieldFE< spacedim, Value >::value	(	const Point &	p,
		const ElementAccessor< spacedim > &	elm
	)

virtual

Returns one value in one given point. ResultType can be used to avoid some costly calculation if the result is trivial.

Definition at line 237 of file field_fe.cc.

Here is the caller graph for this function:

◆ value_list()

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::value_list	(	const Armor::array &	point_list,
		const ElementAccessor< spacedim > &	elm,
		std::vector< typename Value::return_type > &	value_list
	)

virtual

Returns std::vector of scalar values in several points at once.

Definition at line 261 of file field_fe.cc.

◆ vec()

template<int spacedim, class Value >

VectorMPI& FieldFE< spacedim, Value >::vec ( )

inline

Definition at line 181 of file field_fe.hh.

Here is the caller graph for this function:

Member Data Documentation

◆ boundary_dofs_

template<int spacedim, class Value >

std::shared_ptr< std::vector<IntIdx> > FieldFE< spacedim, Value >::boundary_dofs_

private

Hold dofs of boundary elements.

TODO: Temporary solution. Fix problem with merge new DOF handler and boundary Mesh. Will be removed in future.

Definition at line 307 of file field_fe.hh.

◆ boundary_domain_

template<int spacedim, class Value >

bool FieldFE< spacedim, Value >::boundary_domain_

private

Is set in set_mesh method. Value true means, that we accept only boundary element accessors in the value method.

Definition at line 300 of file field_fe.hh.

◆ data_vec_

template<int spacedim, class Value >

VectorMPI FieldFE< spacedim, Value >::data_vec_

private

Store data of Field.

Definition at line 267 of file field_fe.hh.

◆ default_value_

template<int spacedim, class Value >

double FieldFE< spacedim, Value >::default_value_

private

Default value of element if not set in mesh data file.

Definition at line 294 of file field_fe.hh.

◆ dh_

template<int spacedim, class Value >

std::shared_ptr<DOFHandlerMultiDim> FieldFE< spacedim, Value >::dh_

private

DOF handler object.

Definition at line 265 of file field_fe.hh.

◆ discretization_

template<int spacedim, class Value >

OutputTime::DiscreteSpace FieldFE< spacedim, Value >::discretization_

private

Specify section where to find the field data in input mesh file.

Definition at line 285 of file field_fe.hh.

◆ fe_

template<int spacedim, class Value >

MixedPtr<FiniteElement> FieldFE< spacedim, Value >::fe_

private

Definition at line 317 of file field_fe.hh.

◆ fe_item_

template<int spacedim, class Value >

std::array<FEItem, 4> FieldFE< spacedim, Value >::fe_item_

private

Holds specific data of field evaluation over all dimensions.

Definition at line 316 of file field_fe.hh.

◆ fe_values_

template<int spacedim, class Value >

std::vector<FEValues<spacedim> > FieldFE< spacedim, Value >::fe_values_

private

List of FEValues objects of dimensions 0,1,2,3 used for value calculation.

Definition at line 310 of file field_fe.hh.

◆ field_name_

template<int spacedim, class Value >

std::string FieldFE< spacedim, Value >::field_name_

private

field name read from input

Definition at line 282 of file field_fe.hh.

◆ flags_

template<int spacedim, class Value >

FieldFlag::Flags FieldFE< spacedim, Value >::flags_

private

Field flags.

Definition at line 291 of file field_fe.hh.

◆ in_rec_

template<int spacedim, class Value >

Input::Record FieldFE< spacedim, Value >::in_rec_

private

Accessor to Input::Record.

Definition at line 297 of file field_fe.hh.

◆ interpolation_

template<int spacedim, class Value >

DataInterpolation FieldFE< spacedim, Value >::interpolation_

private

Specify type of FE data interpolation.

Definition at line 288 of file field_fe.hh.

◆ reader_file_

template<int spacedim, class Value >

FilePath FieldFE< spacedim, Value >::reader_file_

private

mesh reader file

Definition at line 279 of file field_fe.hh.

◆ registrar

template<int spacedim, class Value >

const int FieldFE< spacedim, Value >::registrar

staticprivate

Initial value:

=
        Input::register_class< FieldFE<spacedim, Value>, unsigned int >("FieldFE") +
        FieldFE<spacedim, Value>::get_input_type().size()

Registrar of class to factory.

Definition at line 320 of file field_fe.hh.

◆ source_target_mesh_elm_map_

template<int spacedim, class Value >

std::shared_ptr<EquivalentMeshMap> FieldFE< spacedim, Value >::source_target_mesh_elm_map_

private

Maps element indices between source (data) and target (computational) mesh if data interpolation is set to equivalent_msh.

Definition at line 313 of file field_fe.hh.

◆ undef_uint

template<int spacedim, class Value >

const unsigned int FieldFE< spacedim, Value >::undef_uint = -1

static

Definition at line 71 of file field_fe.hh.

◆ value_handler0_

template<int spacedim, class Value >

FEValueHandler<0, spacedim, Value> FieldFE< spacedim, Value >::value_handler0_

private

Value handler that allows get value of 0D elements.

Definition at line 270 of file field_fe.hh.

◆ value_handler1_

template<int spacedim, class Value >

FEValueHandler<1, spacedim, Value> FieldFE< spacedim, Value >::value_handler1_

private

Value handler that allows get value of 1D elements.

Definition at line 272 of file field_fe.hh.

◆ value_handler2_

template<int spacedim, class Value >

FEValueHandler<2, spacedim, Value> FieldFE< spacedim, Value >::value_handler2_

private

Value handler that allows get value of 2D elements.

Definition at line 274 of file field_fe.hh.

◆ value_handler3_

template<int spacedim, class Value >

FEValueHandler<3, spacedim, Value> FieldFE< spacedim, Value >::value_handler3_

private

Value handler that allows get value of 3D elements.

Definition at line 276 of file field_fe.hh.

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

/opt/flow123d/flow123d/src/fields/field.hh
/opt/flow123d/flow123d/src/fields/field_fe.hh
/opt/flow123d/flow123d/src/fields/field_fe.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

template<int spacedim, class Value> class FieldFE< spacedim, Value >

Member Typedef Documentation

◆ FactoryBaseType

◆ FieldFactoryBaseType

◆ Point

Member Enumeration Documentation

◆ DataInterpolation

Constructor & Destructor Documentation

◆ FieldFE()

◆ ~FieldFE()

Member Function Documentation

◆ cache_reinit()

◆ cache_update()

◆ calculate_equivalent_values()

◆ calculate_identic_values()

◆ calculate_native_values()

◆ data_size()

◆ DECLARE_EXCEPTION()

◆ fill_boundary_dofs()

◆ fill_fe_item()

◆ fill_fe_system_data()

◆ get_disc_selection_input_type()

◆ get_dofhandler()

◆ get_input_type()

◆ get_interp_selection_input_type()

◆ handle_fe_shape()

◆ init_from_input()

◆ init_quad()

◆ interpolate_gauss()

◆ interpolate_intersection()

◆ local_to_ghost_data_scatter_begin()

◆ local_to_ghost_data_scatter_end()

◆ make_dof_handler()

◆ native_data_to_cache()

◆ set_fe_data()

◆ set_mesh()

◆ set_time()

◆ TYPEDEF_ERR_INFO()

◆ value()

◆ value_list()

◆ vec()

Member Data Documentation

◆ boundary_dofs_

◆ boundary_domain_

◆ data_vec_

◆ default_value_

◆ dh_

◆ discretization_

◆ fe_

◆ fe_item_

◆ fe_values_

◆ field_name_

◆ flags_

◆ in_rec_

◆ interpolation_

◆ reader_file_

◆ registrar

◆ source_target_mesh_elm_map_

◆ undef_uint

◆ value_handler0_

◆ value_handler1_

◆ value_handler2_

◆ value_handler3_

template<int spacedim, class Value>
class FieldFE< spacedim, Value >