Flow123d  JS_before_hm-1602-g5680f2c
Public Types | Public Member Functions | Private Attributes | List of all members
FieldDivide< spacedim, Value > Class Template Reference

#include <field_divide.hh>

Inheritance diagram for FieldDivide< spacedim, Value >:
Inheritance graph
[legend]
Collaboration diagram for FieldDivide< spacedim, Value >:
Collaboration graph
[legend]

Public Types

typedef Field< spacedim, Value >::FactoryBase FactoryBaseType
 
typedef Space< spacedim >::Point Point
 
- Public Types inherited from FieldAlgorithmBase< spacedim, Value >
typedef Space< spacedim >::Point Point
 

Public Member Functions

 FieldDivide (std::shared_ptr< FieldAlgorithmBase< spacedim, Value > > inner_dividend, Field< 3, FieldValue< 3 >::Scalar > inner_divisor, unsigned int n_comp=0)
 
virtual Value::return_type const & 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)
 
bool set_time (const TimeStep &time) override
 
virtual ~FieldDivide ()
 
- Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
 FieldAlgorithmBase (unsigned int n_comp=0)
 
virtual void init_from_input (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)
 
virtual void set_mesh (const Mesh *mesh, bool boundary_domain)
 
void set_component_idx (unsigned int idx)
 
unsigned int n_comp () const
 
FieldResult field_result () const
 
virtual double next_change_time ()
 
virtual void cache_reinit (const ElementCacheMap &cache_map)
 Allows reinit data members or structures in descendants during reinit of FieldValueCache of 'parental' Field<> More...
 
virtual void cache_update (FieldValueCache< typename Value::element_type > &data_cache, ElementCacheMap &cache_map, unsigned int region_patch_idx)
 
virtual void set_native_dh (std::shared_ptr< DOFHandlerMultiDim >)
 
bool is_constant_in_space () const
 
virtual std::vector< const FieldCommon * > set_dependency (FMT_UNUSED FieldSet &field_set)
 
virtual ~FieldAlgorithmBase ()
 

Private Attributes

std::shared_ptr< FieldAlgorithmBase< spacedim, Value > > inner_dividend_
 Field to which we add linear potential. More...
 
Field< 3, FieldValue< 3 >::Scalar > inner_divisor_
 Field to which we add linear potential. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
static std::string template_name ()
 
static Input::Type::Abstractget_input_type ()
 
static const Input::Type::Instanceget_input_type_instance (Input::Type::Selection value_selection=Input::Type::Selection())
 
static const Input::Type::Recordget_field_algo_common_keys ()
 
static std::shared_ptr< FieldAlgorithmBase< spacedim, Value > > function_factory (const Input::AbstractRecord &rec, const struct FieldAlgoBaseInitData &init_data)
 
- Static Public Attributes inherited from FieldAlgorithmBase< spacedim, Value >
static const unsigned int spacedim_ =spacedim
 
static constexpr bool is_enum_valued = std::is_same<typename Value::element_type, FieldEnum>::value
 
- Protected Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
void init_unit_conversion_coefficient (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)
 Init value of unit_conversion_coefficient_ from input. More...
 
- Protected Attributes inherited from FieldAlgorithmBase< spacedim, Value >
TimeStep time_
 Actual time level; initial value is -infinity. More...
 
Value value_
 Last value, prevents passing large values (vectors) by value. More...
 
Value::return_type r_value_
 
FieldResult field_result_
 Indicator of particular values (zero, one) constant over space. More...
 
unsigned int component_idx_
 Specify if the field is part of a MultiField and which component it is. More...
 
double unit_conversion_coefficient_
 Coeficient of conversion of user-defined unit. More...
 
bool is_constant_in_space_
 Flag detects that field is only dependent on time. More...
 

Detailed Description

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

This field is meant to be used to implement for initialization of velocity fields in Darcy flows. You can either use velocity which is proportion of flux and cross section etc. Unfortunately it introduce one more level of indirection, namely one more virtual call for getting the field value.

Definition at line 33 of file field_divide.hh.

Member Typedef Documentation

template<int spacedim, class Value >
typedef Field<spacedim, Value>::FactoryBase FieldDivide< spacedim, Value >::FactoryBaseType

Definition at line 35 of file field_divide.hh.

template<int spacedim, class Value >
typedef Space<spacedim>::Point FieldDivide< spacedim, Value >::Point

Definition at line 36 of file field_divide.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value >
FieldDivide< spacedim, Value >::FieldDivide ( std::shared_ptr< FieldAlgorithmBase< spacedim, Value > >  inner_dividend,
Field< 3, FieldValue< 3 >::Scalar >  inner_divisor,
unsigned int  n_comp = 0 
)

Definition at line 23 of file field_divide.cc.

template<int spacedim, class Value >
FieldDivide< spacedim, Value >::~FieldDivide ( )
virtual

Definition at line 85 of file field_divide.cc.

Member Function Documentation

template<int spacedim, class Value >
bool FieldDivide< spacedim, Value >::set_time ( const TimeStep time)
overridevirtual

Update time and possibly update data.

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 75 of file field_divide.cc.

template<int spacedim, class Value >
Value::return_type const & FieldDivide< 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.

Implements FieldAlgorithmBase< spacedim, Value >.

Definition at line 35 of file field_divide.cc.

template<int spacedim, class Value >
void FieldDivide< 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.

Implements FieldAlgorithmBase< spacedim, Value >.

Definition at line 54 of file field_divide.cc.

Member Data Documentation

template<int spacedim, class Value >
std::shared_ptr< FieldAlgorithmBase<spacedim, Value> > FieldDivide< spacedim, Value >::inner_dividend_
private

Field to which we add linear potential.

Definition at line 62 of file field_divide.hh.

template<int spacedim, class Value >
Field<3, FieldValue<3>::Scalar> FieldDivide< spacedim, Value >::inner_divisor_
private

Field to which we add linear potential.

Definition at line 64 of file field_divide.hh.


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